docs: audit and fix manifest.json page descriptions for SEO - #27267
Merged
nickvigilante merged 3 commits intoJul 23, 2026
Merged
Conversation
Contributor
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
nickvigilante
marked this pull request as ready for review
July 15, 2026 18:01
bpmct
approved these changes
Jul 23, 2026
Rewrite hand-maintained page descriptions in docs/manifest.json so each one is accurate, unique, and within the 70-155 character meta-description target, following meta-description SEO best practices. Highlights: - Fix 5 copy/paste errors where a page reused another page's description: Monitoring, Metrics, Permissions & Policies, STUN and NAT, and Manage Provisioner Jobs. - Replace the reference/index.md description that just repeated its title, and fix the "Coderd API" and "VSCode" wording. - Correct the AI landing page's outdated agent examples. - Expand terse descriptions into the 70-155 character range. Only description string values changed; JSON structure, ordering, and Biome formatting are unchanged. Auto-generated reference subtrees (CLI via scripts/clidocgen, REST API via scripts/apidocgen, and Agent API) are left to their generators. DOCS-576
The beta-features table in feature-stages.md is generated from the beta page descriptions in docs/manifest.json by scripts/release/docs_update_feature_stages.sh. Regenerate it so `make gen` is clean after the manifest description edits. Updates the descriptions for MCP Server, JetBrains Toolbox, and Coder Agents; the User secrets row is unchanged.
Address review feedback on the manifest descriptions: - "Extending Templates" described its features as "Coder-native", but several (Terraform variables and modules, third-party IDEs, Docker) are not native to Coder. Reword to drop the inaccurate claim while keeping the front-loaded, in-range description. - The AI landing page and Coder Tasks descriptions listed Aider as an example agent. Aider is no longer relevant, so replace it with Codex, which is already referenced elsewhere in the docs. feature-stages.md is unaffected: none of these pages are beta-stage, so the generated beta-features table does not change.
nickvigilante
force-pushed
the
vigilante/docs-576-audit-and-fix-docs-manifestjson-page-descriptions-for-seo
branch
from
July 23, 2026 21:09
c2adeaa to
fa9d752
Compare
nickvigilante
deleted the
vigilante/docs-576-audit-and-fix-docs-manifestjson-page-descriptions-for-seo
branch
July 23, 2026 21:24
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
What
Audit and fix the page
descriptionfields indocs/manifest.jsonso each one is accurate, unique, and follows meta-description SEO best practices, targeting 70-155 characters.Tracking: DOCS-576
Why
Many manifest descriptions were terse (243 of 272 hand-maintained descriptions were under 70 characters), a few reused another page's description (copy/paste errors), and one just repeated its own title. These feed the per-page
<meta name="description">on coder.com/docs, so they matter for search snippets and click-through.What changed
The manifest diff is +244 / -244 lines, touching only
descriptionstring values (0 structural lines changed). A second commit regenerates one downstream file (see Generated file below).admin/monitoring/index.md(had Security's text)admin/monitoring/metrics.md(had Logs' text)admin/templates/template-permissions.md(had "Creating Templates" text)admin/networking/stun.md(had Port Forwarding's text)admin/provisioners/manage-provisioner-jobs.md(had the provisioners index text)reference/index.md, whose description merely repeated the title "Reference".&shorthand on the AI Gateway index per the docs style guide.Generated file
docs/install/releases/feature-stages.mdis generated byscripts/release/docs_update_feature_stages.sh, which copies the beta pages' manifest descriptions verbatim into the beta-features table. Three rows (MCP Server, JetBrains Toolbox, Coder Agents) update to match the new descriptions; User secrets is unchanged. Regenerated withmake genso the generated-files check stays clean.Scope / exclusions
Auto-generated reference subtrees are intentionally left untouched, since
make genrebuilds them from source and would revert hand edits (and fail the generated-files check):Reference > Command Linechildren, fromscripts/clidocgen(each command'sShorthelp)Reference > REST APIchildren, fromscripts/apidocgenReference > Agent APIchildrenThe section index nodes themselves (Reference, REST API, Command Line, Agent API) are hand-maintained and are in scope.
Validation
docs/manifest.jsonis valid JSON; diff touches onlydescriptionvalues.&/</>in descriptions.scripts/biome_format.sh) is a no-op on the result.scripts/check_emdash.shpasses.