Repository navigation
docs: keep the public repo to what adopters need to use, run and trust - #2574
Merged
Merged
Conversation
Product folders carried planning, review and decision-deliberation material next to the normative docs. Replace each product's security review notes with a SECURITY-MODEL.md (trust boundaries, operator obligations, accepted residuals), keep rules in the normative docs, and drop definition-of-done files, PR descriptions, salvage ledgers, future-work lists and release review narratives. Recorded-decision files now state behaviour only; their validators refuse a reasoning field, which belongs in the pull request description. Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bebfa8e251
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
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.
Summary
The product folders held planning, review and decision-deliberation material next to the normative docs. This change keeps the public repository to what an adopter needs to use, run, integrate and trust a product today.
SECURITY-MODEL.md: scope and trust boundaries, invariants or rules, operator obligations, and accepted residuals with stable IDs (<PRODUCT>-RES-NN). Coordinator's model includes the caller-subject binding, the review-cancel ownership rule and held runs frommain.README.md,profile/README.md,DESIGN-CONSTRAINTS.md, contracts).recorded-decisions.yamlfiles dropreasoning; their validators refuse it, with a test. Rationale belongs in the pull request description.bregctl apply.AGENTS.md,CONTRIBUTING.mdand the docs-site specification pages name the products that keep aSECURITY-MODEL.md.Checks run locally
npm --prefix docs/site run check:source: passed (evidence anchors, docset, archive lock, frontmatter, markdownlint, vale, SVG).npm --prefix docs/site run test: 946 passed.test_validate_product.py: 44 passed;validate_product.pypassed.check-contracts.sh: 28, 27 and 18 tests passed (before the rebase ontomain; Documents and Messaging re-run after it).validate_contract_artifacts.pyand unit tests: passed.check-port-table.pyand its tests: passed.Not run locally: the Adapter schema drift check. The schemas were regenerated with
adapterctl schemas; one later doc-comment edit inregistry-adapter-core(route.rs) was mirrored intopack.v1alpha1.schema.jsonby hand, so CI's drift check is the verification.