Skip to content

docs: keep the public repo to what adopters need to use, run and trust - #2574

Merged
jeremi merged 2 commits into
mainfrom
docs/public-repo-content-boundary
Nov 6, 2026
Merged

jeremi merged 2 commits into
mainfrom
docs/public-repo-content-boundary

Conversation

@jeremi

@jeremi jeremi commented Nov 6, 2026 •

Copy link
Copy Markdown
Member

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 models. BReg, Casework, Coordinator, Documents, Messaging and Scheduling replace their review notes with a 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 from main.
  • Removed planning material. Definition-of-done files (BReg, Render), Discovery's PR description, salvage ledger, future-work list and decision log, Render's acceptance and OpenFn journey notes, and the Platform 0.1.2 release review. Rules those files stated now live in the normative docs (README.md, profile/README.md, DESIGN-CONSTRAINTS.md, contracts).
  • Recorded decisions state behaviour only. The Documents, Messaging and Scheduling recorded-decisions.yaml files drop reasoning; their validators refuse it, with a test. Rationale belongs in the pull request description.
  • Adapter and Evidence concepts. Section headings and status blocks describe the current product instead of delivery plans; comment tags that pointed at removed decision lists now point at concept sections.
  • Corrections found on the way. The BReg load-test guide now says a request waiting for a pooled connection answers 503 (only work already holding a connection answers 504), and BReg startup diagnostics say which privilege problems point to bregctl apply.
  • Contributor rules. AGENTS.md, CONTRIBUTING.md and the docs-site specification pages name the products that keep a SECURITY-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.
  • BReg test_validate_product.py: 44 passed; validate_product.py passed.
  • Documents, Messaging and Scheduling check-contracts.sh: 28, 27 and 18 tests passed (before the rebase onto main; Documents and Messaging re-run after it).
  • Discovery validate_contract_artifacts.py and unit tests: passed.
  • Evidence script tests: 44 passed.
  • Adapter check-port-table.py and its tests: passed.

Not run locally: the Adapter schema drift check. The schemas were regenerated with adapterctl schemas; one later doc-comment edit in registry-adapter-core (route.rs) was mirrored into pack.v1alpha1.schema.json by hand, so CI's drift check is the verification.

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>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-06T18:20:58.665417Z bebfa8e PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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>
@jeremi
jeremi enabled auto-merge November 6, 2026 19:48
@jeremi
jeremi added this pull request to the merge queue Nov 6, 2026
Merged via the queue into main with commit d3f91f4 Nov 6, 2026
137 of 140 checks passed
@jeremi
jeremi deleted the docs/public-repo-content-boundary branch November 6, 2026 21:01
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