Skip to content

docs(evidence): reorganize Evidence Gateway guidance - #651

Merged
jeremi merged 3 commits into
mainfrom
agent/evidence-gateway-docs
Aug 5, 2026
Merged

docs(evidence): reorganize Evidence Gateway guidance#651
jeremi merged 3 commits into
mainfrom
agent/evidence-gateway-docs

Conversation

@jeremi

@jeremi jeremi commented Aug 5, 2026

Copy link
Copy Markdown
Member

What changed

  • rename the public product surface from Evidence to Evidence Gateway while preserving technical identifiers such as evidence, evidencectl, and registry-evidence
  • reorganize the Evidence Gateway sidebar into task-oriented sections
  • remove the obsolete Evidence-over-Relay route from current navigation and redirect the historical Solmara entry point
  • update architecture, security, glossary, specification, and tutorial prose to show Evidence Gateway using its own configured authoritative HTTP sources
  • update diagrams and generated product-doc synchronization
  • add regression tests for the display name, navigation structure, legacy Relay identifier, and source boundary

Why

The public documentation mixed the old product name with a retired Relay-based topology. That made the navigation repetitive and described an architecture the current Evidence Gateway no longer uses.

Impact

This is a documentation-site change only. Runtime names, wire identifiers, schemas, CLI commands, and archived release history remain unchanged.

Validation

  • npm test (316 passed)
  • npm run check
  • Astro static build and accessibility checks
  • 35,590 internal links and assets validated
  • git diff --check

Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi marked this pull request as ready for review August 5, 2026 17:30
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>

@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: 79b9857e1f

ℹ️ 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 docs/site/src/content/docs/reference/evidence-problems.mdx Outdated
Comment thread docs/site/src/content/docs/tutorials/first-evidence-assertion.mdx Outdated
Comment thread docs/site/src/content/docs/explanation/architecture.mdx Outdated
Comment thread docs/site/scripts/sync-repo-docs.mjs
Comment thread docs/site/src/content/docs/configure/evidence.mdx Outdated
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
@jeremi
jeremi merged commit 9a4365e into main Aug 5, 2026
29 checks passed
@jeremi
jeremi deleted the agent/evidence-gateway-docs branch August 5, 2026 18:00

@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: 2a415ced1a

ℹ️ 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 on lines +89 to +90
Evidence Gateway does not consume this Relay-protected API. It uses its own configured authoritative
HTTP source and does not inherit Relay's authorization or policy model.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve Relay as a fixed source option

For deployments that intentionally configure a Relay-protected read API as the fixed HTTP source, this now tells Relay tutorial readers that Evidence Gateway cannot consume the API they just built. The product boundary is that Relay authorization is not inherited, not that Relay is unsupported as a source; fresh evidence here is this page's new sentence denying consumption outside the already-commented architecture page.

AGENTS.md reference: AGENTS.md:L43-L45

Useful? React with 👍 / 👎.

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