docs: fix P2/P3 typos and syntax errors from drift sweep by nickvigilante · Pull Request #28101 · coder/coder · GitHub
Skip to content

docs: fix P2/P3 typos and syntax errors from drift sweep - #28101

Merged
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-646-docs-p2p3-cosmetic-stale-output-drift-batch-from-docs-637
Aug 14, 2026
Merged

docs: fix P2/P3 typos and syntax errors from drift sweep#28101
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-646-docs-p2p3-cosmetic-stale-output-drift-batch-from-docs-637

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

Summary

High-confidence textual subset of the DOCS-637 P2/P3 drift batch (31 findings total). These 8 fixes are pure typo / grammar / syntax corrections verified directly against the doc source, so they carry no risk of misreconstructed command output.

Changes (6 files)

Page Fix
docs/admin/templates/extending-templates/variables.md Remove doubled word: "file in in the template directory" → "file in the template directory".
docs/admin/networking/port-forwarding.md Grammar: heading "From an coder_app resource" → "From a coder_app resource".
docs/user-guides/workspace-access/index.md Malformed heading "Through with the CLI" → "Through the CLI".
docs/about/contributing/modules.md Conventional-commit example missing the required space: feat(git-clone):addfeat(git-clone): add.
docs/ai-coder/tasks-migration.md Add missing closing double-quotes on Terraform source/version in two snippets that would fail terraform parsing.
docs/admin/users/idp-sync.md Role Sync section said "group sync settings" (copy-paste from the Group Sync section); remove an invalid trailing comma from a JSON output example.

Deferred (remaining ~23 P2/P3 items, not in this PR)

The rest of the batch is stale command-output samples (column/schema changes, sample values) and items that need a content decision (e.g. --psk now deprecated in favor of --key; --address deprecated; an undocumented retention flag). Those need live-output reconstruction or a call on direction, so they're left for follow-up work, consistent with the issue's "handle after the P0/P1 fixes land" guidance. One catalog row (reverse-proxy-nginx.md:57, certbot ws=apache) is already handled by #28086 and is excluded here.

Linear: https://linear.app/codercom/issue/DOCS-646

This PR was created with AI assistance (Coder Agents).

High-confidence textual subset of the DOCS-637 P2/P3 drift batch (verified against the doc source; no live-output reconstruction required):

- variables.md: remove doubled word 'in in'.
- port-forwarding.md: 'From an coder_app' -> 'From a coder_app'.
- workspace-access/index.md: malformed heading 'Through with the CLI' -> 'Through the CLI'.
- modules.md: conventional-commit example 'feat(git-clone):add' -> 'feat(git-clone): add'.
- tasks-migration.md: add missing closing double-quotes on Terraform 'source' and 'version' (two blocks) that would fail to parse.
- idp-sync.md: Role Sync section said 'group sync settings' (copy-paste from Group Sync); remove invalid trailing comma from a JSON output example.

Remaining P2/P3 items (stale command-output reconstructions and items needing a content decision) are deferred to follow-up work.

> This PR was created with AI assistance (Coder Agents).
@linear-code

linear-code Bot commented Aug 13, 2026

Copy link
Copy Markdown

DOCS-646

DOCS-637

@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

Check 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
nickvigilante marked this pull request as ready for review August 14, 2026 16:29

@BobbyHo BobbyHo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@nickvigilante
nickvigilante merged commit 1d189cc into main Aug 14, 2026
56 of 57 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-646-docs-p2p3-cosmetic-stale-output-drift-batch-from-docs-637 branch August 14, 2026 16:44
@github-actions

Copy link
Copy Markdown
Contributor

Backport to release/2.36 created: #28156

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot locked and limited conversation to collaborators Aug 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants