Skip to content

chore(docs): add glossary and cross-link canonical terms - #490

Merged
yordis merged 1 commit into
mainfrom
yordis/docs-glossary
Jul 19, 2026
Merged

chore(docs): add glossary and cross-link canonical terms#490
yordis merged 1 commit into
mainfrom
yordis/docs-glossary

Conversation

@yordis

@yordis yordis commented Jul 19, 2026

Copy link
Copy Markdown
Member

Contributors and readers were inferring shared terms (decider, ACP, WIT, tenancy, and the rest) from scattered ADRs, so the same vocabulary drifted in meaning across documents. A single glossary gives each term one authoritative definition anchored to the ADR or architecture doc that owns it, and cross-linking the docs lets any reader jump to that definition at the first mention.

@cursor

cursor Bot commented Jul 19, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and VitePress config only; no runtime or security behavior changes.

Overview
Adds a Glossary section to the docs site: many term pages under docs/glossary/ (grouped by concern), an index, and VitePress nav/sidebar wired through new helpers that read frontmatter (term, section, order) and build collapsed section groups with a fixed section order.

Cross-links from existing ADRs and architecture pages (../glossary/...) so first mentions of shared vocabulary (protocol, transport, decider, NATS, agent model types, etc.) point at one definition anchored to the owning ADR or architecture doc.

Glossary build fails fast on bad frontmatter or unknown section names via zod validation and GLOSSARY_SECTION_ORDER.

Reviewed by Cursor Bugbot for commit 7592728. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@yordis, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 57 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b7073fa5-baf8-4949-815b-0e78b504239f

📥 Commits

Reviewing files that changed from the base of the PR and between c409b45 and 7592728.

📒 Files selected for processing (96)
  • docs/.vitepress/config.mts
  • docs/.vitepress/helpers.ts
  • docs/adr/0001-workspace-runtime-taxonomy.md
  • docs/adr/0002-rust-crate-boundaries.md
  • docs/adr/0003-ai-protocol-transport-taxonomy.md
  • docs/adr/0004-protocol-and-transport-layering.md
  • docs/adr/0005-polyglot-workspace-layout.md
  • docs/adr/0006-helpers-naming.md
  • docs/adr/0008-opentelemetry-observability.md
  • docs/adr/0009-protocol-buffers-wire-contracts.md
  • docs/adr/0010-testcontainers-for-infrastructure-tests.md
  • docs/adr/0011-jsonrpc-over-nats-binding.md
  • docs/adr/0012-ard-compatible-discovery-catalog.md
  • docs/adr/0013-origin-stream-sequence-header.md
  • docs/adr/0014-command-and-query-naming.md
  • docs/adr/0015-rust-tls-library.md
  • docs/adr/0016-protobuf-rpc-over-nats-micro-binding.md
  • docs/adr/0017-aauth-agent-authentication.md
  • docs/adr/0018-connectrpc-gateway-for-browser-product-surfaces.md
  • docs/adr/0019-console-webapp-stack.md
  • docs/adr/0020-acp-sdk-1x-boundary-and-bridge-traits.md
  • docs/adr/0021-typed-decode-over-passthrough-forwarding.md
  • docs/adr/0022-canonical-acp-wire-methods-on-nats.md
  • docs/adr/0023-secret-management-and-key-custody-direction.md
  • docs/adr/0024-agent-platform-stream-topology.md
  • docs/adr/0025-agent-definition-data-ownership.md
  • docs/adr/0026-command-authorization-principal.md
  • docs/adr/0027-decider-multi-tenancy-primitive.md
  • docs/adr/0028-decider-admission-control-and-backpressure.md
  • docs/adr/0029-decider-retention-and-truncation-watermark.md
  • docs/adr/0030-customer-controlled-key-backend-routing.md
  • docs/adr/0031-agent-implementation-and-session-plan.md
  • docs/adr/0032-model-route-and-credential-binding.md
  • docs/architecture/acp-conformance.md
  • docs/architecture/event-metadata.md
  • docs/glossary/a2a.md
  • docs/glossary/aauth.md
  • docs/glossary/acp.md
  • docs/glossary/admission-control.md
  • docs/glossary/adr.md
  • docs/glossary/agent.md
  • docs/glossary/agentconfiguration.md
  • docs/glossary/agentimplementation.md
  • docs/glossary/agentrevision.md
  • docs/glossary/ard.md
  • docs/glossary/bridge.md
  • docs/glossary/checkpoint.md
  • docs/glossary/command.md
  • docs/glossary/component.md
  • docs/glossary/connectrpc.md
  • docs/glossary/crate.md
  • docs/glossary/credentialbinding.md
  • docs/glossary/decide-evolve-initial-state.md
  • docs/glossary/decider.md
  • docs/glossary/decision.md
  • docs/glossary/epoch.md
  • docs/glossary/event-envelope.md
  • docs/glossary/event-sourcing.md
  • docs/glossary/event.md
  • docs/glossary/executionattempt.md
  • docs/glossary/external-delegated-agent.md
  • docs/glossary/fuel.md
  • docs/glossary/headers.md
  • docs/glossary/index.md
  • docs/glossary/jetstream.md
  • docs/glossary/json-rpc.md
  • docs/glossary/kv-bucket.md
  • docs/glossary/mcp.md
  • docs/glossary/model-access-service.md
  • docs/glossary/modelaccessgrant.md
  • docs/glossary/modelproviderconnection.md
  • docs/glossary/modelselection.md
  • docs/glossary/nats-micro.md
  • docs/glossary/nats.md
  • docs/glossary/openbao.md
  • docs/glossary/opentelemetry.md
  • docs/glossary/pop.md
  • docs/glossary/processor.md
  • docs/glossary/projection.md
  • docs/glossary/protocol-buffers.md
  • docs/glossary/protocol.md
  • docs/glossary/resolvedmodelroute.md
  • docs/glossary/retention-watermark.md
  • docs/glossary/semconv.md
  • docs/glossary/session.md
  • docs/glossary/sessionexecutionplan.md
  • docs/glossary/snapshot.md
  • docs/glossary/stream.md
  • docs/glossary/tenant.md
  • docs/glossary/transport.md
  • docs/glossary/type-url.md
  • docs/glossary/wasm.md
  • docs/glossary/wasmtime.md
  • docs/glossary/wit.md
  • docs/glossary/workspace.md
  • docs/glossary/write-precondition.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yordis/docs-glossary

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@yordis
yordis force-pushed the yordis/docs-glossary branch from 3403aad to 881aef3 Compare July 19, 2026 18:19
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@yordis
yordis force-pushed the yordis/docs-glossary branch from 881aef3 to 7592728 Compare July 19, 2026 18:30
@yordis
yordis merged commit 1924908 into main Jul 19, 2026
5 checks passed
@yordis
yordis deleted the yordis/docs-glossary branch July 19, 2026 18:45
yordis added a commit that referenced this pull request Jul 28, 2026
Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
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