Skip to content

fix(docs): fix P2/P3 typos and syntax errors from drift sweep (backport to release/2.34) - #28170

Merged
nickvigilante merged 1 commit into
release/2.34from
backport/28101-to-2.34
Aug 14, 2026
Merged

fix(docs): fix P2/P3 typos and syntax errors from drift sweep (backport to release/2.34)#28170
nickvigilante merged 1 commit into
release/2.34from
backport/28101-to-2.34

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

Backport of #28101 to release/2.34 (ESR).

Cherry-picked 1d189cc204f9 from main via git cherry-pick -x. Docs-only change; applied cleanly with no conflicts.

The backport label on the original merged PR did not produce a 2.34 backport, so this is created by hand. 2.34 is listed in scripts/release_channels/esr_versions.txt, so it is a valid backport target.

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

## 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):add` → `feat(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).

(cherry picked from commit 1d189cc)
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview

📖 View docs preview for docs/about/contributing/modules.md

@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey @nickvigilante!

This PR is targeting the release/2.34 release branch, but its title does not start with fix: or fix(scope):.

Only bug fixes should be cherry-picked to release branches. If this is a bug fix, please update the PR title to match the conventional commit format:

fix: description of the bug fix
fix(scope): description of the bug fix

If this is not a bug fix, it likely should not target a release branch.

@nickvigilante nickvigilante changed the title docs: fix P2/P3 typos and syntax errors from drift sweep (backport to release/2.34) fix(docs): fix P2/P3 typos and syntax errors from drift sweep (backport to release/2.34) Aug 14, 2026
@nickvigilante
nickvigilante marked this pull request as ready for review August 14, 2026 17:27
@nickvigilante
nickvigilante enabled auto-merge (squash) August 14, 2026 17:27
@nickvigilante
nickvigilante merged commit f518fb2 into release/2.34 Aug 14, 2026
59 checks passed
@nickvigilante
nickvigilante deleted the backport/28101-to-2.34 branch August 14, 2026 17:33
@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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants