Skip to content

docs: add plain-language identification-pipeline walkthrough - #295

Merged
WilfordGrimley merged 1 commit into
masterfrom
docs/identification-pipeline-walkthrough
Jul 21, 2026
Merged

docs: add plain-language identification-pipeline walkthrough#295
WilfordGrimley merged 1 commit into
masterfrom
docs/identification-pipeline-walkthrough

Conversation

@WilfordGrimley

Copy link
Copy Markdown

Description

Adds docs/identification-pipeline.md — the owner-approved, plain-language walkthrough of the printing-identification pipeline (Stage C evidence extraction, Stage D join-key calculator, the human-backed vote gate), as a companion to docs/theory.md (which proves the false-accept bound formally; this one explains the mechanics).

Wiki/site placement (recommendation, not unilaterally decided beyond wiki)

Added docs/identification-pipeline.md to .github/wiki-publish-map.json with targets: ["wiki"] (wiki page name Identification-Pipeline), directly under theory.md's own entry — this matches every other "Understanding the system" entry's current pattern (wiki-only) except overview.md.

Did NOT add a "site" target. docs/documentation-process.md states theory.md and self-hosting.md "remain per this proposal's proposed initial mapping" for the site pipeline — i.e. they're named as next-in-line for site but that widening hasn't happened yet. Adding site to this new companion page ahead of theory.md itself getting it would jump the owner's own stated sequencing. Recommend: if/when theory.md gets widened to ["wiki", "site"], add this page in the same pass (e.g. sitePath: "/guide/how-cards-get-identified").

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. — N/A, docs-only change.
  • I have manually tested my changes as follows:
    • python3 .github/scripts/docs_lint.py — clean.
    • python3 .github/scripts/tests/test_publish_wiki_link_rewrite.py — 4 tests, OK.
    • python3 .github/scripts/tests/test_publish_readme.py — 8 tests, OK.
    • python3 .github/scripts/publish_readme.py . regenerate-and-diff against committed readme.md — no diff (this change doesn't touch a README-REGION source, as expected).
    • npx prettier@2.7.1 --check on every touched file — clean.
  • I have updated any relevant documentation or created new documentation where appropriate. (This PR is that update: CLAUDE.md, docs/README.md, docs/theory.md, .github/wiki-publish-map.json.)

Merge-time checklist item

  • wiki: Identification-Pipeline needs creating on next docs-wiki-publish run (automatic once merged — docs/identification-pipeline.md is now in .github/wiki-publish-map.json). Owner: consider widening to site target together with theory.md per the recommendation above.

@WilfordGrimley
WilfordGrimley merged commit 5640a4c into master Jul 21, 2026
11 checks passed
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.

1 participant