Repository navigation
🤖 docs: rewrite tutorials and the controller and MCP guides in plain English - #165
Merged
Merged
Conversation
…glish Rewrite the three tutorials, the "Deploy the controller" guide, and the setup part of "Run the MCP server" in plain English based on ASD-STE100. Signed-off-by: Thomas Kosiewski <tk@coder.com> --- _Generated with [`xum`](https://github.com/coder/xum) • Model: `anthropic:claude-opus-5-5` • Thinking: `high`_ Change-Id: I8b2284edee1b070b9c23335f595a5c483ff5c59c
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This was referenced Oct 2, 2026
Member
Author
|
@codex security review |
🛡️ Codex Security ReviewSecurity review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
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
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.
Summary
Rewrite the tutorials and two how-to guides in plain English:
docs/tutorials/getting-started.md,docs/tutorials/deploy-coderprovisioner.md,docs/tutorials/deploy-with-argocd.md,docs/how-to/deploy-controller.md, and the setup part ofdocs/how-to/mcp-server.md. The text follows ASD-STE100 (Simplified Technical English) about 80% of the time: short sentences, active voice, conditions before commands, numbered steps, and warnings before the action. Kubernetes and Coder terms, field names, commands, and code stay as they were.This is the second PR of a plain-English docs series (the first is #164). It stands alone and is based on
main.Background
The guides are accurate but dense. Several sentences join a rule, a reason, and an exception with semicolons or colons. Plain English is easier to follow during a procedure and easier to translate.
Implementation
#5-clean-up-optional,#connect-an-external-postgresql-database). One heading without links changed: "Want everything instead?" is now "Run all components instead".mcp-server.mdis byte-identical, so this PR does not conflict with 🤖 deps: bump Coder SDK to v2.37.3 #163, which edits that section.spec.databaserules and the state while the database Secret is missing.Factual fixes
docs/how-to/mcp-server.mdsaid that themcpcontainer exits if--mcp-token-fileis missing, unreadable, empty, or too short. It also exits if the token contains whitespace (internal/app/mcpapp/http.go:105-106). The list now includes that case.Validation
make docs-check(strict mkdocs build),markdownlint-cli20.18.1,cspell8.19.4, andlycheepass on the pushed commit.argocd") and the whitespace gap above."Deploy a Coder Control Plane", before:
"Deploy a Coder Control Plane", after:
"Deploy the controller", after:
Refs: no issue. Part of a plain-English docs pass.
Generated with
xum• Model:anthropic:claude-opus-5-5• Thinking:high