Skip to content

Docs coherence pass: fix stale status/cross-refs, add index + orientation - #68

Merged
WilfordGrimley merged 7 commits into
masterfrom
claude/user-accounts-saved-decks-m8eyf5
Jul 18, 2026
Merged

Docs coherence pass: fix stale status/cross-refs, add index + orientation#68
WilfordGrimley merged 7 commits into
masterfrom
claude/user-accounts-saved-decks-m8eyf5

Conversation

@WilfordGrimley

Copy link
Copy Markdown

Note: this branch also carries Proposal G's earlier survey/spec commits
(user accounts + saved decks, already reported separately) — that work is
a HOLD, no build started; this PR's own scope is the docs coherence pass
below only.

Description

Survey-then-fix documentation coherence pass across docs/ after five
days of multi-worker sprint activity. Mechanical fixes only — no feature
doc's technical content was rewritten, and docs/theory.md's substance
was not touched.

Inventory / survey (four parallel agents, one per doc cluster, plus
manual spot-checks): every doc in docs/ was read in full and checked for
(1) stale status/date claims contradicted by later content in the same
file or by the actual codebase/git history, (2) broken cross-references,
(3) orphaned docs nothing points to. Findings below; anything that needed
judgment rather than a mechanical correction is listed as "not fixed,
flagged" rather than acted on.

Fixed:

  • catalog-completion-plan.md — 3 of 6 ## Part N headers (1, 3, 6)
    carried stale pre-condition parentheticals ("in progress", "after PR Hash-at-ingest + two-threshold clustering: dedup as a free DB read #27
    merges", "starts only after...") contradicted by the file's own ## Status section; updated to match reality (merged/built/merged).
  • printing-tags.md — bumped a 2-day-stale date stamp; removed a false
    "this document's current stage" claim (Stage 6) superseded by Stage 7/8
    content later in the same file; corrected a "full-catalog run: not yet
    fired" claim contradicted by that file's own later sections; disambiguated
    a duplicate pair of "Key files"/"Known gaps" H2 headings left over from
    the pre-rewrite changelog tail (anchor collision hazard).
  • proposal-f-public-stats-page.md — updated its queue-order line and a
    since-completed backfill citation, both superseded by proposal-g's later
    decisions/status.
  • upstreaming/vote-system.md — repointed a dangling reference to a fact
    no longer recorded in CLAUDE.md.
  • troubleshooting.md — an entry marked "still open" (swallowed
    vote-error messages) was actually fixed the same day by PR Editor mobile scroll-chain fix + vote error handling (surfaced messages, friendly 429) #47; updated.
  • infrastructure.md — corrected a Postgres/ES port-binding claim that's
    only true for local dev; prod publishes no host ports at all
    (ports: [] override).
  • card-dom-api.md, google-drive-connect.md, pdf-generator.md,
    print-export-page.md — stale file paths after component relocations
    into feature folders, plus one reference to a deleted component
    (PrintingTagQueue.tsx, superseded by QuestionFeed.tsx).
  • print-export-page.md — added the PringlePrints-flow TODO parity bullet
    missing from Known Gaps (NotMPC's identical TODO was already listed).
  • moderation.md — moved a completed/verified item out of "Known gaps",
    and repointed a cross-reference to where its content actually lives (a
    code comment on post_submit_printing_tag, not printing-tags.md or
    troubleshooting.md as previously miscited).
  • CLAUDE.md — added the missing docs/features/moderation.md index
    entry (every other feature doc was already listed), and a pointer to the
    two new docs below.

Added:

  • docs/README.md — audience-grouped map (understanding the system /
    operating it / plans & proposals / records), one-word status per
    proposal doc.
  • docs/overview.md — orientation page for a cold external reader. The
    federation pitch sends the upstream maintainer to docs/theory.md; this
    is what greets them if they look further: what this fork is, its
    relation to upstream, and the three big systems (catalog + votes,
    identification pipeline, print tooling).
  • docs/reports/README.md — scaffolds the report-relay convention's
    directory ahead of the report-relay/report-relay-2 branches merging
    (per owner confirmation mid-task: the convention is new, its files live
    on those branches, and merge in a docs batch soon).

Not fixed — flagged for the owner instead:

Checklist

  • I have installed pre-commit and installed the hooks with pre-commit install before creating any commits.
  • I have updated any related tests for code I modified or added new tests where appropriate.
  • I have manually tested my changes as follows:
    • Verified every corrected file-path/component claim against the actual frontend/src tree (find/grep) before editing, rather than trusting agent claims uncritically — caught and corrected one agent-reported cross-reference that turned out to be wrong (moderation.md's rate-limiter caveat isn't actually documented in troubleshooting.md, only in a views.py code comment).
    • Verified the Postgres/ES port-binding fix against the actual docker/docker-compose.prod.yml contents.
    • Ran npx prettier@2.7.1 --check across every touched Markdown file plus the two new ones; all pass.
  • I have updated any relevant documentation or created new documentation where appropriate.

Generated by Claude Code

claude added 6 commits July 18, 2026 13:38
Confirms queue position (after current small-item queue + Proposal B,
ahead of C/E-3/F), nav placement (Load in Import dropdown, Save in the
editor action cluster, logged-in only), sharing deferred to v1.1 pending
legal consult, a 100-deck/user abuse-guard cap, and device-local
placeholder handling for LocalFile-sourced slots. Adds Proxxied's
sign-in-to-sync framing as prior art.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Eq8f8QqQ5UKadBW6yHUmxq
…ote tier, loss-proof load flow

Supersedes round 1's fold-Load-into-Import nav decision with a top-level
"My Decks" entry, gated on login. Adds provider-agnostic "Sign in" button
framing (Discord as v1 method, Google noted for v1.1). Adds a new,
separately-build-gated section designing an authed vote-weight tier
(anonymous/authed/moderator), including a deliberately undecided
resolution-gate tradeoff analysis, cast-time-not-resolution-time recording,
and a Sybil-honesty note. Specs a loss-proof-by-construction load-into-editor
flow (auto-snapshot for logged-in users, unchanged confirm-overwrite for
logged-out, reverse breadcrumb of which deck the editor represents).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Eq8f8QqQ5UKadBW6yHUmxq
… cap

Resolves the three remaining open items: the §7 resolution gate stays
status quo for v1 but must route through authed_vote_weight() + settings
so escalating it later is a config change, not a migration (with named
revisit triggers); the authed vote weight is fixed at 1.5 with headroom to
2.0 reserved for a future account-standing extension; auto-snapshots get
their own 5-per-user FIFO ring entirely outside the 100-deck cap, tracked
via a new SavedDeck.kind field with a kind-scoped unique constraint so
auto-generated snapshot names can't collide.

No open decisions remain in the doc.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Eq8f8QqQ5UKadBW6yHUmxq
…tion

Mechanical fixes only, no feature-doc technical content rewritten:
- catalog-completion-plan.md: 3 Part headers (1/3/6) carried stale
  pre-condition parentheticals contradicted by the file's own Status
  section; updated to match (merged/built/merged).
- printing-tags.md: bumped a 2-day-stale date stamp, removed a false
  "current stage" claim superseded by Stage 7/8, corrected a "not yet
  fired" claim contradicted by the same file's later sections, and
  disambiguated a pair of duplicate "Key files"/"Known gaps" headings
  left over from the pre-rewrite changelog tail.
- proposal-f: updated its queue-order line and a since-completed backfill
  citation, both superseded by proposal-g's later decisions/status.
- vote-system.md: repointed a dangling reference to a fact no longer
  recorded in CLAUDE.md.
- troubleshooting.md: an entry marked "still open" was fixed the same
  day by PR #47; updated to reflect that.
- infrastructure.md: corrected a Postgres/ES port-binding claim that
  only holds for local dev, not prod (which publishes no host ports).
- card-dom-api.md, google-drive-connect.md, pdf-generator.md,
  print-export-page.md: stale file paths after component relocations
  into feature folders, and one deleted-component reference
  (PrintingTagQueue.tsx, superseded by QuestionFeed.tsx).
- print-export-page.md: added the PringlePrints-flow TODO parity bullet
  missing from Known Gaps (NotMPC's twin already existed).
- moderation.md: moved a completed/verified item out of "Known gaps",
  and repointed a cross-reference to where its content actually lives
  (a code comment, not printing-tags.md or troubleshooting.md as
  previously miscited).
- CLAUDE.md: added the missing docs/features/moderation.md index entry,
  and a pointer to the two new docs below.

New:
- docs/README.md — audience-grouped map (understanding the system /
  operating it / plans & proposals / records) with one-word status per
  proposal doc.
- docs/overview.md — orientation page for a cold external reader (the
  federation pitch sends the upstream maintainer to docs/theory.md;
  this is what greets them if they look further): what this fork is,
  its relation to upstream, and the three big systems.
- docs/reports/README.md — scaffolds the report-relay convention's
  directory ahead of the report-relay/report-relay-2 branches merging.

Not fixed, flagged for the owner instead (see PR description): several
"as of this writing" PR-status claims in infrastructure.md's upstreaming
section that can't be verified from this sandbox; dated changelog-style
narrative bled into lessons.md/troubleshooting.md's otherwise-durable
entries (a convention question, not a factual error); docs/audits/ and
docs/reports/ content sitting on other unmerged branches, deliberately
left for those PRs to land on their own schedule.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Eq8f8QqQ5UKadBW6yHUmxq
…s-saved-decks-m8eyf5

# Conflicts:
#	docs/infrastructure.md
@WilfordGrimley
WilfordGrimley merged commit 18fbabb into master Jul 18, 2026
@WilfordGrimley
WilfordGrimley deleted the claude/user-accounts-saved-decks-m8eyf5 branch July 18, 2026 17:12
WilfordGrimley added a commit that referenced this pull request Jul 18, 2026
…_request+push:master

Confirmed via API (workflows/test-pre-commit.yml/runs?branch=X, total_count)
that the on:push:branches:["*"] trigger silently dropped events under this
session's high-push-volume merge sweep: zero runs ever fired on 3 confirmed
feature branches (#68, #69/#72, #70), while it fired reliably (2/2) earlier
in the session on a lower-volume branch. test-frontend.yml's on:pull_request
trigger never missed a beat under the same load. Switching to
pull_request (proper PR check) + push:branches:["master"] (covers direct
pushes to master, which this session did twice today for formatting
fixes) - dropping the wildcard branch-push trigger entirely closes both
gaps: PR branches get a reliable check, and direct-to-master pushes still
get checked too.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants