Conversation
Member
Author
|
@codex review Please review this documentation refresh for accuracy and clarity. |
Member
Author
|
@codex review Addressed docs-quality markdownlint failures in the aggregated API how-to ordered list formatting. |
Summary: - rewrote architecture, troubleshooting, and docs index pages - improved README structure and app mode coverage - updated tutorial/deploy guides for correctness and actionability - fixed control-plane sample image and made license secret optional --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: $2.88_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=2.88 -->
Member
Author
|
@codex review Updated per feedback: moved cspell additions into |
|
Codex Review: Didn't find any major issues. Bravo. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Member
Author
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.
Summary
This PR refreshes the user-facing docs and README for accuracy, structure, and learnability. It updates outdated architecture/troubleshooting guidance, improves getting-started and deployment how-tos, and fixes the control-plane sample manifest used in docs and CI smoke flows.
Background
Recent documentation drift left several pages out of date with current runtime behavior (
--app=alldefault mode, expanded app modes, codersdk-backed aggregated storage, and current Kubernetes resource names). The README also needed a clearer project narrative and more consistent onboarding flow.Implementation
README.mdinto a structured project entrypoint with badges, capability summary, app-mode matrix, docs links, commands, repo layout, and contributing checks.docs/explanation/architecture.md:all,controller,aggregated-apiserver,mcp-http)--appdefault behaviordocs/how-to/troubleshooting.mdwith correct resource names and current failure modes.docs/index.mdwith clearer orientation, links, and quick commands.docs/tutorials/getting-started.mdwith improved flow, verification, and cleanup.docs/how-to/deploy-controller.mdnow explicitly covers controller-only modedocs/how-to/deploy-aggregated-apiserver.mdnow distinguishes all-in-one vs standalone mode and required standalone settingsconfig/samples/coder_v1alpha1_codercontrolplane.yaml:ghcr.io/coder/coder:latestlicenseSecretRefmade optional/commentedValidation
make verify-vendormake testmake buildmake lintmake docs-checkRisks
Generated with
mux• Model:openai:gpt-5.3-codex• Thinking:xhigh• Cost:$2.88