docs: add a glossary to the reference section#27165
Draft
nickvigilante wants to merge 3 commits into
Draft
Conversation
Add a reference glossary that defines Coder-specific terms and product names, including the coder_agent / workspace agent / Coder Agents disambiguation, with links to the relevant docs.
Docs preview📖 View docs preview for |
Reorganize the glossary from category sections into A-Z sections, one H2 per letter with terms as H3s. Letters with no terms are omitted. Definitions, links, and the agent disambiguation callout are unchanged.
Normalize both entries to the hyphenated "sub-agent" spelling used elsewhere in the docs, split them into "Sub-agent (Coder Agents)" and "Sub-agent (dev containers)", add mutual "Not to be confused with" cross-references, and note that the dev container sub-agent is a Coder term, not part of the Development Container Specification.
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
1 participant
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.
Adds a reference glossary at
docs/reference/glossary.mdthat defines the Coder-specific terms and product names readers encounter across the docs, and registers it indocs/manifest.jsonunder Reference.The page prioritizes the term collisions around "agent": it disambiguates Coder Agents (the AI product), the workspace agent (the in-workspace daemon), and the
coder_agentTerraform resource with an[!IMPORTANT]callout and cross-referenced entries. Every definition was checked against the current docs, and every internal link is a relative path that resolves in-repo.Decision log and verification notes
Scope of this PR
Glossary: <term>cross-link callouts across the docs IA, the search-ranking boost, the workspace-daemon rename decision, and the CONTRIBUTING note plus lint guard.Source
Corrections made vs. the draft
docs/ai-coder/ai-governance.md.docs/ai-coder/tasks.md.nsjail(default) andlandjail.docs/admin/integrations/opentofu.md.docs/manifest.json("state": ["premium"]).Local validation
markdownlint-cli2: 0 errors.scripts/check_emdash.sh: clean.Coderpackage): 0 errors, 0 warnings, 0 suggestions.siblings_only).Reviewer note