feat: v1.0.0 — UX polish, security hardening, code quality
UI/UX: - Bill detail page tab UI (Analysis / Timeline / Votes / Notes) - Topic tag pills on bill detail and listing pages — filtered to known topics, clickable, properly labelled via shared lib/topics.ts - Notes panel always-open in Notes tab; sign-in prompt for guests - Collapsible sidebar with icon-only mode and localStorage persistence - Bills page defaults to has-text filter enabled - Follow mode dropdown transparency fix - Favicon (Landmark icon, blue background) Security: - Fernet encryption for ntfy passwords at rest (app/core/crypto.py) - Separate ENCRYPTION_SECRET_KEY env var; falls back to JWT derivation - ntfy_password no longer returned in GET response — replaced with ntfy_password_set: bool; NotificationSettingsUpdate type for writes - JWT_SECRET_KEY fail-fast on startup if using default placeholder - get_optional_user catches (JWTError, ValueError) only, not Exception Bug fixes & code quality: - Dashboard N+1 topic query replaced with single OR query - notification_utils.py topic follower N+1 replaced with batch query - Note query in bill detail page gated on token (enabled: !!token) - search.py max_length=500 guard against oversized queries - CollectionCreate.validate_name wired up with @field_validator - LLM_RATE_LIMIT_RPM default raised from 10 to 50 Authored by: Jack Levy
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
import Link from "next/link";
|
||||
import {
|
||||
BarChart2,
|
||||
Bell,
|
||||
Bookmark,
|
||||
Calendar,
|
||||
@@ -8,9 +9,15 @@ import {
|
||||
Filter,
|
||||
Heart,
|
||||
HelpCircle,
|
||||
ListChecks,
|
||||
Mail,
|
||||
MessageSquare,
|
||||
Rss,
|
||||
Shield,
|
||||
Share2,
|
||||
StickyNote,
|
||||
TrendingUp,
|
||||
Users,
|
||||
Zap,
|
||||
} from "lucide-react";
|
||||
|
||||
@@ -63,11 +70,16 @@ export default function HowItWorksPage() {
|
||||
{/* Jump links */}
|
||||
<div className="flex flex-wrap gap-2 mt-3">
|
||||
{[
|
||||
{ href: "#follow", label: "Following" },
|
||||
{ href: "#collections", label: "Collections" },
|
||||
{ href: "#notifications", label: "Notifications" },
|
||||
{ href: "#briefs", label: "AI Briefs" },
|
||||
{ href: "#bills", label: "Bills" },
|
||||
{ href: "#follow", label: "Following" },
|
||||
{ href: "#collections", label: "Collections" },
|
||||
{ href: "#notifications", label: "Notifications" },
|
||||
{ href: "#briefs", label: "AI Briefs" },
|
||||
{ href: "#votes", label: "Votes" },
|
||||
{ href: "#alignment", label: "Alignment" },
|
||||
{ href: "#notes", label: "Notes" },
|
||||
{ href: "#bills", label: "Bills" },
|
||||
{ href: "#members-topics", label: "Members & Topics" },
|
||||
{ href: "#dashboard", label: "Dashboard" },
|
||||
].map(({ href, label }) => (
|
||||
<a
|
||||
key={href}
|
||||
@@ -143,7 +155,7 @@ export default function HowItWorksPage() {
|
||||
</Item>
|
||||
<Item icon={Share2} color="bg-purple-100 text-purple-600 dark:bg-purple-900/30 dark:text-purple-400" title="Sharing">
|
||||
Every collection has a unique share link. Anyone with the link can view the collection —
|
||||
no account required. The link works whether the collection is public or private.
|
||||
no account required.
|
||||
</Item>
|
||||
</div>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
@@ -156,37 +168,40 @@ export default function HowItWorksPage() {
|
||||
{/* Notifications */}
|
||||
<Section id="notifications" title="Notifications" icon={Bell}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
PocketVeto delivers alerts through two independent channels — use either or both.
|
||||
PocketVeto delivers alerts through three independent channels — use any combination.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={Bell} color="bg-blue-100 text-blue-600 dark:bg-blue-900/30 dark:text-blue-400" title="Push via ntfy">
|
||||
<a href="https://ntfy.sh" target="_blank" rel="noopener noreferrer" className="text-primary hover:underline">
|
||||
ntfy
|
||||
</a>
|
||||
<a href="https://ntfy.sh" target="_blank" rel="noopener noreferrer" className="text-primary hover:underline">ntfy</a>
|
||||
{" "}is a free, open-source push notification service. Configure a topic URL in{" "}
|
||||
<Link href="/notifications" className="text-primary hover:underline">Notifications</Link>{" "}
|
||||
and receive real-time alerts on any device with the ntfy app.
|
||||
</Item>
|
||||
<Item icon={Clock} color="bg-amber-100 text-amber-700 dark:bg-amber-900/30 dark:text-amber-400" title="Quiet hours">
|
||||
Pause push notifications during set hours (e.g. 10 PM – 8 AM). Events that arrive
|
||||
during quiet hours are queued and sent as a batch when the window ends.
|
||||
</Item>
|
||||
<Item icon={Calendar} color="bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-400" title="Digest mode">
|
||||
Instead of one push per event, receive a single bundled summary on a daily or weekly
|
||||
schedule. Your RSS feed is always real-time regardless of this setting.
|
||||
<Item icon={Mail} color="bg-indigo-100 text-indigo-600 dark:bg-indigo-900/30 dark:text-indigo-400" title="Email">
|
||||
Receive alerts as plain-text emails. Add your address in{" "}
|
||||
<Link href="/notifications" className="text-primary hover:underline">Notifications → Email</Link>.
|
||||
Every email includes a one-click unsubscribe link, and your address is never used for
|
||||
anything other than bill alerts.
|
||||
</Item>
|
||||
<Item icon={Rss} color="bg-orange-100 text-orange-600 dark:bg-orange-900/30 dark:text-orange-400" title="RSS feed">
|
||||
A private, tokenized RSS feed of all your bill alerts. Subscribe in any RSS reader
|
||||
(Feedly, NetNewsWire, etc.). Completely independent of ntfy.
|
||||
(Feedly, NetNewsWire, etc.). Always real-time, completely independent of the other channels.
|
||||
</Item>
|
||||
<Item icon={Filter} color="bg-teal-100 text-teal-700 dark:bg-teal-900/30 dark:text-teal-400" title="Discovery alerts">
|
||||
<Item icon={Clock} color="bg-amber-100 text-amber-700 dark:bg-amber-900/30 dark:text-amber-400" title="Quiet hours">
|
||||
Pause push and email notifications during set hours (e.g. 10 PM – 8 AM). Events that
|
||||
arrive during quiet hours are queued and sent as a batch when the window ends.
|
||||
</Item>
|
||||
<Item icon={Calendar} color="bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-400" title="Digest mode">
|
||||
Instead of one alert per event, receive a single bundled summary on a daily or weekly
|
||||
schedule. Your RSS feed is always real-time regardless of this setting.
|
||||
</Item>
|
||||
<Item icon={MessageSquare} color="bg-teal-100 text-teal-700 dark:bg-teal-900/30 dark:text-teal-400" title="Discovery alerts">
|
||||
Member and topic follows generate Discovery alerts — separate from the bills you follow
|
||||
directly. In{" "}
|
||||
<Link href="/notifications" className="text-primary hover:underline">Alert Filters → Discovery</Link>,
|
||||
you can enable or disable these independently, tune which event types trigger them, and
|
||||
mute specific members or topics you'd rather not hear about without unfollowing them.
|
||||
Each notification also shows a “why” line so you always know which follow
|
||||
triggered it.
|
||||
mute specific members or topics without unfollowing them. Each notification includes a
|
||||
“why” line so you always know which follow triggered it.
|
||||
</Item>
|
||||
</div>
|
||||
</Section>
|
||||
@@ -194,29 +209,86 @@ export default function HowItWorksPage() {
|
||||
{/* AI Briefs */}
|
||||
<Section id="briefs" title="AI Briefs" icon={FileText}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
For bills with published official text, PocketVeto generates a plain-English AI brief.
|
||||
For bills with published official text, PocketVeto generates a plain-English AI brief
|
||||
automatically — no action needed on your part.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={FileText} color="bg-blue-100 text-blue-600 dark:bg-blue-900/30 dark:text-blue-400" title="What's in a brief">
|
||||
A plain-English summary, key policy points with references to specific bill sections
|
||||
(§ chips), and a risks section that flags potential unintended consequences or contested
|
||||
provisions.
|
||||
(§ chips you can expand to see the quoted source text), and a risks section that flags
|
||||
potential unintended consequences or contested provisions.
|
||||
</Item>
|
||||
<Item icon={Share2} color="bg-purple-100 text-purple-600 dark:bg-purple-900/30 dark:text-purple-400" title="Sharing a brief">
|
||||
Click the share icon in the brief panel to copy a public link. Anyone can read the
|
||||
brief at that URL — no login required.
|
||||
</Item>
|
||||
<Item icon={Zap} color="bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-400" title="Draft a letter">
|
||||
Use the Draft Letter panel (below the brief) to generate a personalised letter to your
|
||||
representative based on the brief's key points.
|
||||
Use the Draft Letter panel in the Analysis tab to generate a personalised letter to
|
||||
your representative based on the brief's key points.
|
||||
</Item>
|
||||
</div>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
Briefs are only generated for bills where GovInfo has published official text. Bills
|
||||
without text show a “No text” badge on their card.
|
||||
without text show a “No text” badge on their card. When a bill is amended,
|
||||
a new “What Changed” brief is generated automatically alongside the original.
|
||||
</p>
|
||||
</Section>
|
||||
|
||||
{/* Votes */}
|
||||
<Section id="votes" title="Roll-call votes" icon={ListChecks}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
The <strong>Votes</strong> tab on any bill page shows every recorded roll-call vote for
|
||||
that bill, fetched directly from official House and Senate XML sources.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={ListChecks} color="bg-blue-100 text-blue-600 dark:bg-blue-900/30 dark:text-blue-400" title="Vote breakdown">
|
||||
Each vote shows the result, chamber, roll number, date, and a visual Yea/Nay bar with
|
||||
exact counts.
|
||||
</Item>
|
||||
<Item icon={Users} color="bg-purple-100 text-purple-600 dark:bg-purple-900/30 dark:text-purple-400" title="Followed member positions">
|
||||
If any of your followed members voted on the bill, their individual Yea/Nay positions
|
||||
are surfaced directly in the vote row — no need to dig through the full member list.
|
||||
</Item>
|
||||
</div>
|
||||
</Section>
|
||||
|
||||
{/* Alignment */}
|
||||
<Section id="alignment" title="Representation Alignment" icon={BarChart2}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
The <Link href="/alignment" className="text-primary hover:underline">Alignment</Link> page
|
||||
shows how often your followed members vote in line with your stated bill positions.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={Zap} color="bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-400" title="How it's calculated">
|
||||
For every bill you follow with Pocket Boost or Pocket Veto, PocketVeto checks how each
|
||||
of your followed members voted. A Yea on a boosted bill counts as aligned; a Nay on a
|
||||
vetoed bill counts as aligned. Not Voting and Present are excluded.
|
||||
</Item>
|
||||
<Item icon={BarChart2} color="bg-blue-100 text-blue-600 dark:bg-blue-900/30 dark:text-blue-400" title="Alignment score">
|
||||
Each followed member gets an alignment percentage based on all overlapping votes. Members
|
||||
are ranked from most to least aligned with your positions.
|
||||
</Item>
|
||||
</div>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
Alignment only appears for members who have actually voted on bills you've stanced.
|
||||
Follow more members and stake positions on more bills to build a fuller picture.
|
||||
</p>
|
||||
</Section>
|
||||
|
||||
{/* Notes */}
|
||||
<Section id="notes" title="Notes" icon={StickyNote}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Add a personal note to any bill — visible only to you. Find it in the{" "}
|
||||
<strong>Notes</strong> tab on any bill detail page.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={StickyNote} color="bg-yellow-100 text-yellow-700 dark:bg-yellow-900/30 dark:text-yellow-400" title="Pinning">
|
||||
Pin a note to float it above the tab bar so it's always visible when you open the
|
||||
bill, regardless of which tab you're on.
|
||||
</Item>
|
||||
</div>
|
||||
</Section>
|
||||
|
||||
{/* Bills */}
|
||||
<Section id="bills" title="Browsing bills" icon={FileText}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
@@ -227,13 +299,55 @@ export default function HowItWorksPage() {
|
||||
<p><strong className="text-foreground">Search</strong> — matches bill ID, title, and short title.</p>
|
||||
<p><strong className="text-foreground">Chamber</strong> — House or Senate.</p>
|
||||
<p><strong className="text-foreground">Topic</strong> — AI-tagged policy area (healthcare, defense, etc.).</p>
|
||||
<p><strong className="text-foreground">Has text</strong> — show only bills with published official text available for AI briefing.</p>
|
||||
<p><strong className="text-foreground">Has text</strong> — show only bills with published official text. On by default.</p>
|
||||
</div>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
Clicking a topic tag on any bill or following page takes you directly to that filtered
|
||||
view on the Bills page.
|
||||
Each bill page is organised into four tabs: <strong>Analysis</strong> (AI brief + draft
|
||||
letter), <strong>Timeline</strong> (action history), <strong>Votes</strong> (roll-call
|
||||
records), and <strong>Notes</strong> (your personal note).
|
||||
Topic tags appear just below the tab bar — click any tag to jump to that filtered view.
|
||||
</p>
|
||||
</Section>
|
||||
|
||||
{/* Members & Topics */}
|
||||
<Section id="members-topics" title="Members & Topics" icon={Users}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Browse and follow legislators and policy topics independently of specific bills.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={Users} color="bg-blue-100 text-blue-600 dark:bg-blue-900/30 dark:text-blue-400" title="Members">
|
||||
The <Link href="/members" className="text-primary hover:underline">Members</Link> page
|
||||
lists all current members of Congress. Each member page shows their sponsored bills,
|
||||
news coverage, voting trend, and — once enough votes are recorded —
|
||||
an <strong>effectiveness score</strong> ranking how often their sponsored bills advance.
|
||||
</Item>
|
||||
<Item icon={Filter} color="bg-teal-100 text-teal-700 dark:bg-teal-900/30 dark:text-teal-400" title="Topics">
|
||||
The <Link href="/topics" className="text-primary hover:underline">Topics</Link> page
|
||||
lists all AI-tagged policy areas. Following a topic sends you a Discovery alert whenever
|
||||
a new bill is tagged with it — useful for staying on top of a policy area without
|
||||
tracking individual bills.
|
||||
</Item>
|
||||
</div>
|
||||
</Section>
|
||||
|
||||
{/* Dashboard */}
|
||||
<Section id="dashboard" title="Dashboard" icon={TrendingUp}>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
The <Link href="/" className="text-primary hover:underline">Dashboard</Link> is your
|
||||
personalised home view, split into two areas.
|
||||
</p>
|
||||
<div className="space-y-3">
|
||||
<Item icon={Heart} color="bg-red-100 text-red-600 dark:bg-red-900/30 dark:text-red-400" title="Your feed">
|
||||
Bills from your follows — directly followed bills, bills sponsored by followed members,
|
||||
and bills matching followed topics — sorted by latest activity.
|
||||
</Item>
|
||||
<Item icon={TrendingUp} color="bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-400" title="Trending">
|
||||
The top 10 bills by composite trend score, calculated nightly from news article volume
|
||||
(NewsAPI + Google News) and Google Trends interest. A bill climbing here is getting real
|
||||
public attention regardless of whether you follow it.
|
||||
</Item>
|
||||
</div>
|
||||
</Section>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user