Skip to content

P1: Reconcile every document and legacy spec with current source #277

Closed

Description

@tomqwu

Current Priority Decision

Owner direction, 2026-09-13: complete Church/Basketball business workflows and day-to-day operations for every role first; billing and platform readiness later.

Execution lane: phase: business-flow. Current business milestone: #289.
This section overrides older priority, start conditions, broad dependency order and launch estimates below. Keep the detailed technical recommendations where compatible. Execute only the NOW slice; do not expand a mixed issue into its whole production scope. Record completed slice receipts in #289; keep this issue open while retained later work remains.

NOW

Reconcile the docs actually used to implement/operate the selected business slices: current roadmap, README, Church/Basketball role guides, commands, coverage receipts and relevant instructions. Keep the complete document inventory, but do not require all 176 manual files before the next role workflow.

LATER

Complete every remaining manual/generated/historical document disposition with its appropriate platform/native/feature track. Keep this broad issue open for remaining scope; active-slice acceptance is recorded separately.

Validation stays local. No CI checks, hosted reviewers or Ollama code review. Preserve tenant isolation, real member responses and atomic roster changes. A deferred feature is not permission to expose an unfixed vulnerability. No deployment, paid-provider activation or production sign-off is authorized by this reprioritization.

Before implementation, read #252 and #289; finish one role/work package with tests, local review and affected docs/assets. The earlier completion receipt below covers whole-issue closure, not a requirement to finish every deferred package before the business milestone.


Current Implementation Handoff

Prepared 2026-09-13 for a lower-cost builder at source 21a4a804aa57580451edded04736b1f51aef7e48.
No CI checks. All implementation validation and code review run locally.
Use the shared builder contract and this issue's work packages; no xhigh model or automatic model upgrade is required. This is a detailed recommendation, not a claim that a smaller model cannot make mistakes or that tests have passed.

Risk/review focus: Medium: misleading instructions and incomplete documentation coverage.
Start condition: Start only the NOW work package defined above. Use its local business prerequisites, not the entire older platform-release dependency list.

Source of Truth and Current State

The existing body contains the 176-file manual-document ledger; preserve every entry. Generated client docs are a separate 120-document cohort owned by #191. Static link counts are candidates, not a complete link/semantic certification.

This handoff supersedes stale implementation statements in the background below. Preserve existing successful behavior and tests. Recheck the current branch before editing; the baseline is a source pointer, not permission to discard newer changes.

Dependencies and Ownership

Recommended Decisions

  1. Create one structured disposition record per manual file: path, current/historical/generated status, canonical destination, verified source/command references, owner issue, review date/SHA and outcome.
  2. Edit by small coherent family: root/current navigation, operational docs, feature docs, nested specs, agent templates, mobile. Prefer scoped corrections and historical banners over deleting useful history.
  3. For current docs require true claims and runnable references. For archived docs retain original context with a working supersession pointer; explicitly retire missing historical targets rather than invent files.
  4. Validate Markdown relative paths/anchors plus HTML href/src/images using a real parser. Separate external links, generated anchors and intentional historical exceptions in the report.

Small Work Packages

Each item is one reviewable slice, not permission for one giant PR. Add the failing regression first; finish code, tests and affected docs for that slice together. Leave this issue open until all packages and original acceptance criteria are satisfied or explicitly revised by the owner.

  • 277.1: Build the ledger from git ls-files, cross-check all 176 entries and assign disposition/owner before editing batches.
  • 277.2: Repair root/current docs first, then each remaining family, testing commands against disposable fixtures and linking actual implementation owners.
  • 277.3: Handle generated docs via P2: Regenerate the mobile API client and validate native release #191 and reconcile GitHub historical/current pointers without reopening completed history blindly.
  • 277.4: Run link/claim checks and rendered review across the entire manifest; close only when every row has an outcome and all dedicated issues supply their evidence.

Required Regression Cases

These are specifications for tests to add/retain, not claimed execution results. Each new negative case must assert unchanged unauthorized state and zero forbidden side effects.

  • T277-01: New tracked manual document missing from ledger -> local validator fails.
  • T277-02: A missing relative target or HTML image -> failure with exact source/path; a deliberately retired historical link -> explicit exception, not silently ignored.
  • T277-03: Historical instructions cannot override current no-CI policy or select obsolete work; new/current docs contain no stale feature completion claims.
  • T277-04: Deleting/renaming a document requires all current inbound links to be updated; generated docs remain reproducible.

Local Commands and Evidence

Existing targeted commands (paths checked against the audit source; run only after the stated safe preflight):

git ls-files '*.md' '*.md.disabled'
poetry run pytest tests/unit/test_local_validation_policy.py tests/unit/test_readme_unpark.py -q

Also run the shared formatting/lint/touched-type/unit/full-suite and local review protocol from #252 for the final pushed revision. Add new targeted tests to these commands when implemented. Run API and browser tiers in separate processes. Native, PostgreSQL, image, provider and operator drills require their explicit environment; an unavailable tool/target is blocked/not run, never a pass.

Schema and Compatibility

No application migration. A new local ledger/checker is a proposed artifact, not an existing command; document its supported invocation after implementation.

Stop Conditions

Do not rewrite feature claims that require unapproved product behavior. Mark them unavailable/blocked and link their owner; do not hand-edit generated client docs.

After two failed focused repair attempts without new diagnostic evidence, stop the affected package and post the exact failure, commands, suspected boundary and needed decision. Do not silently broaden scope, weaken tests or upgrade models. A fresh local reviewer checks: Sample every family and verify the full ledger reconciles tracked counts; a banner/search result alone cannot mark a file reviewed.

Completion Receipt

  • Work-package and regression IDs above map to changed files and actual results.
  • Commands, versions, dates, pass/fail/skip/not-run counts, logs/screenshots and tested head/base SHAs are linked.
  • A separate local review records findings and resolution; self-review is labeled if used and is not misrepresented as independent review.
  • Affected docs/README/playbooks/screenshots and dependency/roadmap status are reconciled, not left as unnamed follow-ups.
  • If implementation is authorized through PR/merge, GitHub reports mergeable and the shared local-evidence requirements are met; reviewer agents never merge.
  • No hosted CI check, status attestation, Ollama reviewer, live provider action, deployment, real-data purge or store submission was introduced by implication.

Copyable Builder Prompt

First read this issue's Current Priority Decision and #289. Run only its NOW slice.
If this issue is deferred, report that state instead of starting the older package list.
Implement the next ready work package in tomqwu/SignUpFlow issue #277.
Read its Current Implementation Handoff and #252 Builder Handoff Contract first.
Inspect current source and preserve newer/unrelated changes. Start with the
package's failing regression, then complete code, local tests, local review and
affected docs/assets together. Do not skip acceptance or invent passing evidence.
No CI checks or Ollama code review. Do not deploy, activate providers, purge real
data or submit to stores. Stop and report unmet prerequisites or policy decisions.
Record the package/test IDs and exact reviewed/tested source SHAs before claiming done.

Earlier Audit and Acceptance Context

Parent roadmap: #252. Audit baseline: 21a4a804aa57580451edded04736b1f51aef7e48 (2026-09-13).

No CI checks. All code review, formatting, lint, types, migrations, tests, security scans and artifact validation run locally. Do not add hosted validation, required CI statuses, synthetic success statuses or an Ollama code reviewer. Pages publication is separate. Record commands, environment, results, skips, limitations and reviewed head/base SHAs. Builders merge only after complete local evidence and GitHub mergeability; reviewers never merge.

This is planned work, not an implementation or production-readiness sign-off. The audit did not rerun the application/test suite, deploy, contact delivery/payment providers or validate a native release.

Findings

The tracked documentation inventory contains 296 Markdown-like files: 176 manually maintained and 120 generated client documents. An inline-relative-link scan found 110 distinct file/target candidate failures: 44 across 11 manual files and 66 in generated client docs. This is not an external-link, anchor or HTML-link audit. Only 25 manual files match a historical/supersession notice near the top; a notice alone does not validate the contents.

docs/README.md still contains 20 distinct missing relative targets. docs/IMPLEMENTATION_PLAN.md tells readers to add an already-present timezone field and modify removed frontend paths. API_README, EVENT_ROLES_FEATURE, MULTI_ORG_LIMITATIONS and RBAC_IMPLEMENTATION_COMPLETE reference missing paths. Legacy completion reports/specs must not select new work or establish release readiness.

Work Plan

  1. Classify each file below as current/update, historical/archive, superseded/redirect, or generated. Record its canonical replacement, source/test references, owner issue and disposition; do not blanket-delete history.
  2. Read retained current content end to end. Reconcile routes, permissions versus scheduling roles, feature state, commands, counts, stack, dates, readiness claims and no-CI policy against source. Assign substantive fixes to the linked implementation issue, not this ledger.
  3. Preserve historical context with an obvious dated notice and a working current destination. Retire obsolete task instructions; do not recreate already-shipped fields/features.
  4. Fix or explicitly retire unavailable links; validate Markdown links, HTML image/link sources and anchors locally. Do not invent replacement files.
  5. Reconcile docs/INDEX.md, docs/README.md, docs/ROADMAP.md, root instructions, nested specs and GitHub roadmap/status together.
  6. Reconcile all 91 pre-audit GitHub issues and open PR Sprint 4 follow-up — implement ICS format for /solutions/{id}/export #251 with current source. Keep completed history closed; add clear supersession pointers to obsolete CI/marathon instructions. Every real residual defect gets an open owner issue.
  7. Handle all 120 mobile/api_client Markdown files through reproducible generation under P2: Regenerate the mobile API client and validate native release #191, not hand edits.

Acceptance

  • All 176 entries have a documented disposition and substantive completion evidence, not just a search hit or new banner.
  • All 120 generated documents are accounted for under P2: Regenerate the mobile API client and validate native release #191; broken generated links have an intentional regeneration/template fix.
  • Local link validation has zero unexplained missing targets; retired historical references are explicit, non-misleading exceptions.
  • No current page or generated agent instruction prescribes CI checks, Ollama code review, nonexistent commands or unsupported production/compliance claims.
  • Current README, public site, playbooks, screenshots, security/operations docs and agent files are reconciled through their dedicated issues before this closes.
  • Every roadmap task is source-checked and has an owner issue; old percentages/effort totals are not copied as current evidence.

Local Validation

Run the documentation/link/claim checks introduced by this work, preview the rendered Markdown, execute affected examples in a disposable environment, and follow the repository local review/full-suite rules for each shipping PR. This issue does not claim the entire inventory has already had a line-by-line semantic review.

Per-file Completion Ledger

Unchecked means the full current/historical disposition remains to be completed, even where this audit sampled or statically inspected it.

.claude (8)

  • .claude/commands/speckit.analyze.md
  • .claude/commands/speckit.checklist.md
  • .claude/commands/speckit.clarify.md
  • .claude/commands/speckit.constitution.md
  • .claude/commands/speckit.implement.md
  • .claude/commands/speckit.plan.md
  • .claude/commands/speckit.specify.md
  • .claude/commands/speckit.tasks.md

.github (1)

  • .github/copilot-instructions.md

.specify (8)

  • .specify/memory/constitution.md
  • .specify/templates/agent-file-template.md
  • .specify/templates/checklist-template.md
  • .specify/templates/feature-progress-template.md
  • .specify/templates/plan-template.md
  • .specify/templates/project-progress-template.md
  • .specify/templates/spec-template.md
  • .specify/templates/tasks-template.md

Root (4)

  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • README.md

docs (55)

  • docs/API.md
  • docs/API_QUICKSTART.md
  • docs/API_README.md
  • docs/BACKEND_DEBUG.md
  • docs/COMPREHENSIVE_TEST_SUITE.md
  • docs/DATETIME_ARCHITECTURE.md
  • docs/DEBUG_REFACTORING.md
  • docs/DEPLOYMENT_GUIDE.md
  • docs/DOCKER_DEVELOPMENT.md
  • docs/DOCUMENTATION_STATUS.md
  • docs/ENVIRONMENT_SETUP.md
  • docs/EVENT_ROLES_FEATURE.md
  • docs/FINAL_STATUS.md
  • docs/IMPLEMENTATION_COMPLETE.md
  • docs/IMPLEMENTATION_PLAN.md
  • docs/INDEX.md
  • docs/LAUNCH_ROADMAP.md
  • docs/MULTI_ORG_LIMITATIONS.md
  • docs/NEXT_STEPS.md
  • docs/QUICK_START.md
  • docs/RATE_LIMITING.md
  • docs/RBAC_AUDIT.md
  • docs/RBAC_IMPLEMENTATION_COMPLETE.md
  • docs/README.md
  • docs/REFACTORING.md
  • docs/ROADMAP.md
  • docs/RUNBOOK.md
  • docs/SAAS_DESIGN.md
  • docs/SECURITY.md
  • docs/SECURITY_MIGRATION.md
  • docs/SPEC_KIT_SETUP.md
  • docs/TESTING.md
  • docs/TESTING_ACTION_PLAN.md
  • docs/TEST_PERFORMANCE.md
  • docs/TEST_STRATEGY.md
  • docs/TEST_SUMMARY.md
  • docs/USER_STORIES.md
  • docs/WORKSPACE_ORGANIZATION.md
  • docs/ai-agent-coding-strategy.md
  • docs/ai-pr-review.md
  • docs/archive/SPEC_KIT_PROGRESS.md
  • docs/archive/TECHNICAL_DEBT.md
  • docs/features/e2e-invitation-workflow.md
  • docs/features/password-reset.md
  • docs/playbooks/README.md
  • docs/playbooks/basketball.md
  • docs/playbooks/church.md
  • docs/playbooks/validation.md
  • docs/research-log.md
  • docs/research/legacy-migrations/README.md
  • docs/saas/CODEX_PROVIDER_FALLBACK.md
  • docs/saas/EMAIL_INTEGRATION_PLAN.md
  • docs/saas/SMOKE_TESTING_EMAIL.md
  • docs/saas/STRIPE_INTEGRATION_PLAN.md
  • docs/source-repos.md

examples (1)

  • examples/README.md

mobile (7)

  • mobile/ANDROID_RELEASE.md
  • mobile/README.md
  • mobile/SMOKE.md
  • mobile/TESTFLIGHT.md
  • mobile/fastlane/README.md
  • mobile/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md
  • mobile/prototype/brand-spec.md

specs (92)

  • specs/000-user-onboarding/checklists/requirements.md
  • specs/000-user-onboarding/contracts/analytics-api.md
  • specs/000-user-onboarding/contracts/checklist-api.md
  • specs/000-user-onboarding/contracts/sample-data-api.md
  • specs/000-user-onboarding/contracts/wizard-api.md
  • specs/000-user-onboarding/data-model.md
  • specs/000-user-onboarding/plan.md
  • specs/000-user-onboarding/quickstart.md
  • specs/000-user-onboarding/research.md
  • specs/000-user-onboarding/spec.md
  • specs/000-user-onboarding/tasks.md
  • specs/001-email-notifications/checklists/requirements.md
  • specs/001-email-notifications/contracts/sendgrid-webhooks.md
  • specs/001-email-notifications/data-model.md
  • specs/001-email-notifications/plan.md
  • specs/001-email-notifications/quickstart.md
  • specs/001-email-notifications/research.md
  • specs/001-email-notifications/spec.md
  • specs/001-email-notifications/tasks.md
  • specs/011-billing-subscription-system/checklists/requirements.md
  • specs/011-billing-subscription-system/contracts/billing-api.md
  • specs/011-billing-subscription-system/contracts/webhook-api.md
  • specs/011-billing-subscription-system/data-model.md
  • specs/011-billing-subscription-system/plan.md
  • specs/011-billing-subscription-system/progress.md
  • specs/011-billing-subscription-system/quickstart.md
  • specs/011-billing-subscription-system/research.md
  • specs/011-billing-subscription-system/spec.md
  • specs/011-billing-subscription-system/tasks.md
  • specs/012-i18n-system/spec.md
  • specs/013-production-infrastructure/checklists/requirements.md
  • specs/013-production-infrastructure/contracts/backup-restore.md
  • specs/013-production-infrastructure/contracts/deployment-api.md
  • specs/013-production-infrastructure/contracts/health-check.md
  • specs/013-production-infrastructure/plan.md
  • specs/013-production-infrastructure/quickstart.md
  • specs/013-production-infrastructure/research.md
  • specs/013-production-infrastructure/spec.md
  • specs/014-security-hardening/checklists/requirements.md
  • specs/014-security-hardening/contracts/2fa-api.md
  • specs/014-security-hardening/contracts/audit-logging.md
  • specs/014-security-hardening/contracts/csrf-protection.md
  • specs/014-security-hardening/contracts/password-reset.md
  • specs/014-security-hardening/contracts/rate-limiting.md
  • specs/014-security-hardening/contracts/session-management.md
  • specs/014-security-hardening/plan.md
  • specs/014-security-hardening/quickstart.md
  • specs/014-security-hardening/research.md
  • specs/014-security-hardening/spec.md
  • specs/015-monitoring-observability/checklists/requirements.md
  • specs/015-monitoring-observability/contracts/alert-configuration-api.md
  • specs/015-monitoring-observability/contracts/error-tracking-integration.md
  • specs/015-monitoring-observability/contracts/health-check-api.md
  • specs/015-monitoring-observability/contracts/log-search-api.md
  • specs/015-monitoring-observability/contracts/metrics-api.md
  • specs/015-monitoring-observability/contracts/status-page-api.md
  • specs/015-monitoring-observability/data-model.md
  • specs/015-monitoring-observability/plan.md
  • specs/015-monitoring-observability/quickstart.md
  • specs/015-monitoring-observability/research.md
  • specs/015-monitoring-observability/spec.md
  • specs/016-recurring-events-ui/checklists/requirements.md
  • specs/016-recurring-events-ui/contracts/bulk-edit-api.md
  • specs/016-recurring-events-ui/contracts/calendar-preview-api.md
  • specs/016-recurring-events-ui/contracts/recurrence-exceptions-api.md
  • specs/016-recurring-events-ui/contracts/recurring-series-api.md
  • specs/016-recurring-events-ui/data-model.md
  • specs/016-recurring-events-ui/plan.md
  • specs/016-recurring-events-ui/quickstart.md
  • specs/016-recurring-events-ui/research.md
  • specs/016-recurring-events-ui/spec.md
  • specs/017-manual-schedule-editing/checklists/requirements.md
  • specs/017-manual-schedule-editing/spec.md
  • specs/018-mobile-responsive-design/checklists/requirements.md
  • specs/018-mobile-responsive-design/spec.md
  • specs/019-sms-notifications/checklists/requirements.md
  • specs/019-sms-notifications/contracts/preferences-api.md
  • specs/019-sms-notifications/contracts/sms-api.md
  • specs/019-sms-notifications/contracts/templates-api.md
  • specs/019-sms-notifications/contracts/webhooks-api.md
  • specs/019-sms-notifications/data-model.md
  • specs/019-sms-notifications/plan.md
  • specs/019-sms-notifications/quickstart.md
  • specs/019-sms-notifications/research.md
  • specs/019-sms-notifications/spec.md
  • specs/019-sms-notifications/tasks.md
  • specs/020-solver-quality-changemin/spec.md
  • specs/021-sendgrid-integration/spec.md.disabled
  • specs/022-flutter-mobile-app/spec.md
  • specs/023-sprint-8-completion/spec.md
  • specs/024-sprint-9-completion/spec.md
  • specs/COMPLETED-000-safety-verification/spec.md

Delivery Ownership and Cross-links

Suggested owner: Documentation maintainer + backend/mobile reviewers (not yet assigned). Roadmap order: 0 and final reconciliation in 3. Implement in small locally reviewed PRs; no source changes are made by filing this issue.

Related delivery: #278 README/examples/site; #279 playbooks; #280 screenshots; #281 local validation; #282 agent generators; #283 tools; #284 security/ops docs; #285 web UI; #286 publication; #191 generated mobile docs.

Activity

  1. added
    phase: business-flowCurrent Church/Basketball business-flow work; execute only the active slice in each issue.
    on Sep 13, 2026
  2. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation ledger receipt from PR #320: merged 6e833d446161ade845cb07cdd3987fbf948ab4e3. Added the maintained production configuration contract and reconciled README, roadmap, runbook, index, documentation status, examples, Compose, and effective runtime names. The runbook now states that backup/restore and rollback are not accepted procedures instead of presenting untested commands. Docs tests and the exact-head full suite passed (1,779 passed / 21 skipped). #277 remains open for the broader legacy catalog and later platform/release documentation.

  3. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation reconciliation receipt from #321

    The production-artifact package merged at 9a5d3acde85f51f93a390c23e48a7009a6f2d97b and updated every affected current document in the same PR:

    • README.md
    • docs/BACKEND_DEBUG.md
    • docs/DOCUMENTATION_STATUS.md
    • docs/PRODUCTION_CONFIGURATION.md
    • docs/ROADMAP.md
    • docs/RUNBOOK.md
    • docs/TESTING.md
    • docs/TOOLS.md
    • examples/api_client_example.py

    The current docs now distinguish:

    • local source tests from exact-image artifact acceptance,
    • one-shot migrations from replica startup,
    • private PostgreSQL/authenticated Redis from public exposure,
    • proven local behavior from unrun staging/rollback/provider acceptance,
    • production stdout logging from development file logging.

    Final-SHA evidence: 1,793 passed/21 skipped in make test-all, 8/8 PostgreSQL acceptance, artifact image sha256:fb00fdfbac4306eb736058572fed555efb9bc7a482d29532633972ec34b62416 passed. Existing README scenario and screenshot-manifest checks passed; no UI source changed, so no screenshot recapture was required.

    Keep this ledger open for later monitoring, recovery/retention, provider, mobile, staging, and release evidence.

  4. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation reconciliation increment:

    • PR Add production monitoring and sanitized probes #322 updated README, backend debugging, deployment, production configuration, runbook, security, testing, documentation status, roadmap, environment examples, Compose, and the OpenAPI snapshot to match the new monitoring/probe behavior.
    • The docs now distinguish local monitoring evidence from missing staging/provider/operator evidence and preserve the local-only test/review policy.
    • Validated source: 39a6dfbf7c22dc82c5e0810b00c327bdb95b9e11; merged as fd9e42755d54cc5a180c782eb39f4ae54e526888.
    • Documentation truthfulness tests passed as part of 1,814 passed, 21 skipped.

    PR: #322
    This issue remains open because later recovery, retention, deployment, and provider packages will require another whole-repository reconciliation.

  5. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Local validation receipt for PR #323: source 5997d05 produced 1,827 passed, 21 skipped, zero failures/errors, including 73 Playwright tests. Report: test-artifacts/local-validation/20260915T043918.866073Z-99569-97e92ba0/report.json. Recovery 12/12 and PostgreSQL 8/8 also passed. Main merge: 0657971. No hosted tests or Ollama review ran.

  6. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation receipt from PR #324 (merged at 779074f3a806f318b9edebf3a77d92b0a1573f16): README, TESTING, ROADMAP, SECURITY, TOOLS, INDEX, DOCUMENTATION_STATUS, CONTRIBUTING, mobile TestFlight guidance, and all three agent instruction surfaces now describe the local-only release security command and its evidence boundaries. The new canonical docs/SECURITY_VALIDATION.md explicitly separates source/image/native scope, unknown license review, external providers, and deployment claims. This is a completed current-doc family, not whole-ledger closure; the 176 manual + 120 generated document disposition remains open here.

  7. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation receipt from #256 / PR #325

    Current roadmap and documentation ledger now describe tenant-bound read-only checkout verification, payment-method ownership checks, default-off billing, and the remaining #270 provider boundary. docs/saas/STRIPE_INTEGRATION_PLAN.md is explicitly marked as a historical 2025 proposal and no longer presents old prices as current/final. Merged at 0b1d6f10f2335d6ddcc36be29d4a6ec4a13d267e.

  8. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Documentation receipt from #257

    PR #326 updates README, API authorization, production configuration, runbook, roadmap, documentation reconciliation, environment examples, OpenAPI, and generated Dart SMS request docs. It records default-off status, exact signed callback URLs, string IDs, tenant/tuple checks, provider deferral, and the generator limitation.

    No browser layout changed. The documentation ledger explicitly records why the existing Church/Basketball screenshots remain current.

  9. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Local completion receipt: documentation ledger and current-link validation

    PR #331 merged as 2c127e62eea189ce5a44a5de6d31de3ccc2d521e.

    Completed scope

    • 277.1 / T277-01: Added docs/documentation_ledger.yaml, reconciling the current Git inventory of 188 manually maintained Markdown documents and 139 generated mobile API documents. Every manual row records current/historical state, canonical destination, owner, verified sources, and disposition.
    • 277.2 / T277-02: Added make test-docs and scripts/validate_documentation.py. It fails on missing manual rows, missing canonical/source references, broken current relative paths, HTML links/images, and missing heading anchors. Historical link exceptions must be explicit.
    • T277-03: The current README, documentation index/status/testing guidance, agent files, contributor workflow, and local-only validation contract now point to the ledger and contain no new CI or Ollama review gate.
    • T277-04 (manual-document portion): Repaired current stale links in README, Docker development, and environment setup. Renames/deletions of current documents are now caught through inbound-link validation.
    • Stabilized the existing recurring-availability Playwright case by proving persistence after reload before clearing the recurrence. This removed an HTMX listener-binding race without changing application behavior.

    The issue's older 176/manual and 120/generated counts were an audit snapshot. The merged validator derives the authoritative current counts from git ls-files; the reviewed source contains 188 manual and 139 generated documents.

    Exact local evidence

    • Tested head: 7ab44e870d092a42f3855da114750d73811d68bc
    • Reviewed base: 21010c59d31e991b8992407c546469a42dce9738
    • Merge commit: 2c127e62eea189ce5a44a5de6d31de3ccc2d521e
    • DEVELOPER_DIR=/Library/Developer/CommandLineTools make test-all: 1,979 passed, 21 skipped, 0 failed/errors, including 73 Playwright passed
    • Report: test-artifacts/local-validation/20260915T150225.525310Z-80677-bfba648a/report.json
    • DEVELOPER_DIR=/Library/Developer/CommandLineTools make test-docs: passed, 188 manual / 139 generated
    • Black, Ruff, targeted mypy, Poetry lock validation, and diff whitespace checks: passed
    • Secret scan contained only documentation terms such as password-reset and the policy instruction not to commit secrets; no credential values
    • Local self-review found no unresolved findings and is explicitly not represented as independent review
    • GitHub reported PR Add a complete documentation disposition ledger #331 MERGEABLE / CLEAN before merge
    • No hosted CI, Ollama review, provider operation, deployment, real-data operation, or branch deletion occurred

    Remaining acceptance

    Keep #277 open. The generated-document portion of 277.3 / T277-04 remains owned by #191 and must be repaired through reproducible OpenAPI client generation, never by hand editing generated files. A full rendered-document review and final cross-issue reconciliation must also be evidenced before closure.

  10. tomqwu commented on Sep 15, 2026

    @tomqwu
    OwnerAuthor

    Final documentation completion receipt

    Issue #277 is complete across its maintained and generated cohorts.

    • PR Add a complete documentation disposition ledger #331 merged the source-derived ledger and validator at 2c127e62eea189ce5a44a5de6d31de3ccc2d521e, accounting for every maintained document with status, canonical destination, owner, sources, and disposition.
    • PR Make mobile client generation reproducible #332 merged deterministic mobile generation at a591b4133356ee398fa9555411a7a77b23192b8f, resolving the generated-document owner dependency without hand edits. The current generated cohort is 138 files after the canonical schema removed obsolete OrganizationCreate.
    • On merged main, make test-docs passed with 188 manual / 138 generated documents. Current relative paths, HTML links/images, heading anchors, canonical/source references, inventory coverage, and inbound links have no unexplained failures.
    • All 326 tracked Markdown-like files were rendered successfully through GitHub's GFM POST /markdown renderer in repository context. This supplements the source/semantic family review and proves the current files are renderer-accepted; it is not a claim that historical plans are current.
    • Current README, public workflow/playbooks, 44-image screenshot manifest, testing policy, agent instructions, security/operations docs, mobile support/release docs, roadmap, and documentation index/status are reconciled to their implemented or explicitly unverified state.
    • The latest exact-head full suite for PR Make mobile client generation reproducible #332 passed 1,985 / 21 skipped / 0 failed/errors, including 73 Playwright cases; its documentation test tier includes the ledger invariants.
    • Local self-review was used and is not represented as independent review. GitHub reported both PRs MERGEABLE / CLEAN before builder merge.

    Historical documents and specifications remain intentionally retained and explicitly point to current canonical owners; their old percentages, CI/Ollama instructions, and production claims do not control current work. Open production/provider/native tickets remain open for their real external evidence, which is the documented disposition rather than a documentation defect.

    No hosted CI, Ollama code review, provider call, deployment, real-data operation, branch deletion, or production/compliance certification occurred.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    phase: business-flowCurrent Church/Basketball business-flow work; execute only the active slice in each issue.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions