Repository navigation
docs: refresh README to the actual repository and repair stale base pointers - #182
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
…ointers The README described a repository that no longer exists, and was omitted three load-bearing directories. README corrections, each verified against the tree: - Layout listed four migrations; there are ten (001-010). Now 001-010. - Layout omitted tools/ entirely. tools/parsers/liteparse/shim.py is a PRODUCTION parse shim - executed by the Go adapter (client.go) and copied into the worker image - so a Python runtime is required in production, and tools/corpus/ is the sole reproducer of the committed corpus. Both are now listed, under a heading that distinguishes them from the spec artifacts. - Layout omitted scripts/ci/, where the four anti-fake-green and credential-isolation gates CI runs live. - Layout omitted fixtures/parser_eval/ (45 cases, sha256-verified). - The ADR list omitted 005, 006, 007 and 011. - 'Python golden suite (no network, untouched by Go work)' understated where the contract is enforced: the Go coverage registry now asserts all 19 golden cases and fails a fixture case that has no Go assertion. - Setup said 'uv run pytest tests/ -q'; CI runs 'uv run pytest tests/unit -q'. Aligned, and the exact command was run to confirm it. - Phase progression stopped at 'Next: Groq qualification'. Now records the durable claim submission, the 19-case contract, the expiry ADR and the cleared advisory, and states plainly that release is NOT QUALIFIED. Stale base pointers repaired (W17): - docs/specs/09_DECISION_LOG.md - 'current base is main@dffa160' -> main@c971727. - docs/specs/10_PHASE3_E2E_QUALIFICATION.md - the dated reconciliation narrative keeps 'main@dffa160 (APA-64)' as history and appends the 2026-10-21 reconciliation to main@c971727. - docs/specs/06_PROGRESS.md - pointer -> main@c971727, with a note stating the convention: the pointer records the commit the file's content reflects, so a documentation-only merge advances main afterwards and the pointer trails by its own merge. That is expected, not drift. Historical records were not rewritten: the only surviving main@dffa160 in docs/ is the dated historical clause inside the Phase-3 file. Co-Authored-By: opencode <no-reply@opencode.ai>
Aparnap2
force-pushed
the
docs/readme-and-doc-pointers
branch
from
October 24, 2026 05:46
163e205 to
76a168d
Compare
Aparnap2
marked this pull request as ready for review
October 24, 2026 05:49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Four documentation files, no code:
README.mddocs/specs/06_PROGRESS.mddocs/specs/09_DECISION_LOG.mddocs/specs/10_PHASE3_E2E_QUALIFICATION.mdBase
main@c971727bf71a6a5dcedea9f426db0a8927a00bab· commit163e205· branchdocs/readme-and-doc-pointers.The README was stale — every claim below was verified against the tree
migrations 001 (schema+RLS) 002 (grants) 003 (evidence) 009 (investigations)001–010(documents, outbox, worker role, investigation reports, app-core grants, workflow launches)tools/entrytools/parsers/liteparse/shim.pyis a production parse shim — exec'd by the Go adapter (client.go, 13 references) and copied into the worker image (Dockerfile.worker, 4 references) — so a Python runtime is required in production.tools/corpus/is the sole reproducer of the committed corpusscripts/ci/entryfixtures/parser_eval/entry001 002 004 008 009005,006,007, and011tests/unit/ Python golden suite (no network, untouched by Go work)uv run pytest tests/ -quv run pytest tests/unit -q;tests/contains onlyunit/. Aligned, and the exact command was executed to confirm it workspackages/domain/is now labelled demoted per ADR-001, andtools/is introduced with the heading "Python tooling that is NOT spec artifacts" so the distinction cannot be misread.W17 — stale base pointers, history preserved
09_DECISION_LOG.md— "current base ismain@dffa160" →main@c971727.10_PHASE3_E2E_QUALIFICATION.md— the dated narrative keepsmain@dffa160 (APA-64)as history and appends "Reconciled 2026-10-21: the base is nowmain@c971727."06_PROGRESS.md— pointer →main@c971727, plus a note recording the convention: the pointer records the commit whose content the file reflects; a documentation-only merge advancesmainafterwards, so the pointer trails by its own merge — that is expected, not drift. Without that note every documentation merge looks like a fresh regression, which is what kept W17 recurring.The only surviving
main@dffa160anywhere indocs/is that dated historical clause. No historical record was rewritten.Verification
Every factual claim in the new README was re-derived from the tree, not from the old README.
Status
Documentation only. Not authorized to merge — opened as a draft for review. Release status NOT QUALIFIED; this closes no release gate and changes no behaviour.