docs: one living STATUS.md, and archive the superseded planning docs - #17
Merged
Merged
Conversation
Steps 6 and 7 of the clarification plan. The problem was not that any single document was wrong — it was that "where is X?" had several plausible answers, spread across files written months apart, and no file said which one was current. STATUS.md is now that file. It carries the tag, the branch roles, what CI actually runs, what landed most recently, the two open decisions with no deadline, and the state of the points system. Its own rule is at the top: if another file disagrees with it, the other file is the one to fix. Two open decisions are recorded rather than left implicit. The licence Change Date is FIXED at 2030-05-13, so the protection window shrinks every day without anyone choosing it — out of audit scope, but a decision by default is still a decision. And whether a pool on a pausable Token-2022 mint should be gauge-eligible, since emissions could otherwise be voted toward a frozen market. AUDIT_SCOPE.md and AUDIT_PACKAGES.md move to docs/archive/. Both were already excluded from this public repository and stay excluded — .gitignore is extended to cover the new path, deliberately, because they carry commercial detail. Their one factual error is corrected on the way in: both listed Token-2022 as "not in code", which stopped being true with the audit-2026-09-01 tag. CLAUDE.md: the program layout table still described a flat tree with a top-level state.rs / amm.rs / amm_state.rs, none of which have existed since the 2026-08-30 restructure — corrected. Adds the Token-2022 section, including the part that is easy to get wrong: the surface is NOT bounded to amm.rs, because bribes.rs takes an arbitrary reward_mint. The 57-instruction figure is marked as historical and now points at STATUS.md.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Steps 6 and 7 of the clarification plan — the last two before the scope is sealed.
The problem was never that a single document was wrong. It was that "where is X?" had several plausible answers spread across files written months apart, and nothing said which was current.
STATUS.md— the file to trustOne living document: the tag, branch roles, what CI actually runs, what landed most recently, the open decisions, and the state of the points system. Its own rule is at the top — if another file disagrees with it, the other file is the one to fix.
Two open decisions are now recorded instead of drifting:
2030-05-13. Not a rolling window, so the protection shrinks every day without anyone choosing it. Out of audit scope — nobody audits aLICENSE— but a decision by default is still a decision.docs/archive/AUDIT_SCOPE.mdandAUDIT_PACKAGES.mdmove there. Both were already excluded from this public repository and stay excluded —.gitignoreis extended to cover the new path deliberately, since they carry commercial detail. Verified withgit check-ignorethat nothing became trackable.Their one factual error is corrected on the way in: both listed Token-2022 as "not in code", which stopped being true at
audit-2026-09-01.CLAUDE.mdstate.rs/amm.rs/amm_state.rs— none of which have existed since the 2026-08-30 restructure. Corrected to the realinstructions/+state/layout.amm.rs, becausebribes.rstakes an arbitraryreward_mint.STATUS.md.Docs only — no code, no IDL change.
🤖 Generated with Claude Code