🤖 refactor: refocus docs for product deployment flow#78
Conversation
|
@codex review |
1 similar comment
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5540b3e263
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
|
Context on the open Codex thread: This docs/sample update is intentionally written for the upcoming API change that removes I agree the current |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5540b3e263
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
Move contributor workflow out of README, add CONTRIBUTING, and align tutorials/samples with the product deployment path (coder namespace, external provisioner tutorial, clearer example naming). --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.00`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.00 -->
Use kubectl short aliases (`sa`, `rb`) in the verification snippet to satisfy cspell in docs-quality CI. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.00`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.00 -->
Rename the Argo CD tutorial title and add an estimated duration so it aligns with the product-focused tutorial naming and format used across docs. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.00`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.00 -->
ThomasK33
force-pushed
the
documentation-vq09
branch
from
5540b3e to
e232bc6
Compare
|
@codex review |
|
@codex review Please take another look. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e232bc6031
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
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".
Add an explicit `kubectl create namespace coder` step before applying the sample control plane so the CONTRIBUTING quick-start works with namespaced sample manifests. --- _Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.00`_ <!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.00 -->
|
@codex review Please take another look. |
|
Codex Review: Didn't find any major issues. Delightful! ℹ️ 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". |
1 participant
Summary
Refocused repository docs from contributor-centric setup toward product/operator usage, added a dedicated External Provisioner tutorial, and standardized tutorial/sample namespace usage on
coder(neverdefault).Background
The existing README/tutorial flow mixed end-user docs with contributor workflows and repeated setup steps across tutorials, which increased drift risk. This PR separates contributor guidance, simplifies tutorial progression, and updates examples for clearer terminology and safer defaults.
Implementation
README.mdto be end-user focused and link to hosted docs.CONTRIBUTING.mdand moved local-dev/contributor workflows there.docs/index.mdDeploy a Coder Control PlaneDeploy an External Provisioneras a follow-on tutorialexamples/aggregatedtoexamples/coder-templatesand updated references.coder:config/samples/coder_v1alpha1_codercontrolplane.yamlconfig/samples/coder_v1alpha1_coderprovisioner.yamlconfig/samples/coder_v1alpha1_coderworkspaceproxy.yamlcredentialsSecretRefusage from the sample/tutorials in this branch context.Validation
make verify-vendormake testmake buildmake lintmake docs-check(fails by design whenmkdocs.ymlchanges becausedocs-reference-checkasserts nomkdocs.ymldiff)mkdocs build --strictRisks
Low to medium. Changes are mostly docs/samples, but sample behavior assumptions were updated to match the intended API direction in this workstream. Generated API reference docs are intentionally left for the API-removal PR that updates types/CRDs.
Generated with
mux• Model:openai:gpt-5.3-codex• Thinking:xhigh• Cost:$0.00