Skip to content

fix(docs): align reference contracts with source - #747

Merged
jeremi merged 8 commits into
mainfrom
agent/reference-accuracy-pr
Aug 13, 2026
Merged

fix(docs): align reference contracts with source#747
jeremi merged 8 commits into
mainfrom
agent/reference-accuracy-pr

Conversation

@jeremi

@jeremi jeremi commented Aug 13, 2026

Copy link
Copy Markdown
Member

Summary

  • align Evidence batch unresolved outcomes across frozen contracts, runtime regressions, and security traceability
  • harden Relay fixture isolation and document the seven project workflow commands plus the bounded tooling namespace
  • generate exact CLI references with complete conflict modeling, public help coverage, and review state bound to the catalog digest
  • correct API, contract, standards, environment, error, and client-reference claims against current source
  • rebase onto current main and adapt the references for Mint readiness healthchecks and Relay language-server governed-closure confinement

Review and security

  • Evidence batch-contract clarification approved by the Evidence maintainer
  • builds on the merged Relay editor-diagnostic fix in fix(relayctl): harden editor diagnostics #746
  • no credentials, source data, or protected test values are published by the changed docs or diagnostics
  • the refreshed CLI catalog is 0499aa2018ddaa3de409020eb95981d0dabf9cc7048172b3343ff07a54005e0d; its 74 generated pages are intentionally draft until a human docs/CLI maintainer reviews that exact digest
  • Relay fixture-isolation and Tier-C trust claims still require the applicable human product/security and docs sign-offs before merge

Validation

  • cargo fmt --check
  • affected crates: cargo clippy --locked --all-targets -- -D warnings
  • affected crate test suites, including loopback-backed Evidence and Relay tests
  • products/evidence/scripts/check-contracts.sh
  • products/evidence/scripts/check-source-neutrality.sh
  • products/evidence/scripts/check-verifier-portability.sh
  • products/relay-v2/scripts/check-contracts.sh
  • products/relay-v2/scripts/test-http.sh
  • docs/site: npm test
  • docs/site: npm run check
  • git diff --check

All listed local checks pass on rebased head d79e9b021. The generated CLI section remains unpublished until exact-catalog review metadata is recorded.

@jeremi
jeremi force-pushed the agent/reference-accuracy-pr branch from 5ef9ac4 to 4a81f04 Compare August 13, 2026 10:35
@jeremi
jeremi marked this pull request as ready for review August 13, 2026 13:44
jeremi added 7 commits August 13, 2026 22:41
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi force-pushed the agent/reference-accuracy-pr branch from 4a81f04 to d79e9b0 Compare August 13, 2026 15:52

@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: d79e9b0216

ℹ️ 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".

Comment thread crates/registry-cli-docs/Cargo.toml
Comment thread crates/registry-relay-v2/src/tooling.rs
Comment thread docs/site/src/content/docs/spec/rs-terms.mdx Outdated
Comment thread docs/site/scripts/check-evidence-links.mjs
Comment thread docs/site/src/data/cli-reference.yaml
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi merged commit 1191dc0 into main Aug 13, 2026
35 checks passed
@jeremi
jeremi deleted the agent/reference-accuracy-pr branch August 13, 2026 16:32
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