Repository navigation
🤖 docs: rewrite the aggregated API behavior reference in plain English - #169
Merged
Merged
Conversation
Rewrite the aggregated API behavior reference in plain English based on ASD-STE100. The template build section gets only small edits, because other work changes it. 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: Ic577ed0bf086b3f6b3ce2e1e785acdff78c0c310
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. |
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
docs/reference/aggregated-api-behavior.mdin plain English. The text follows ASD-STE100 (Simplified Technical English) about 80% of the time: short sentences, active voice, simple tenses, and one fact per sentence. Status codes, field names, commands, and code stay as they were.This is the fifth and last PR of a plain-English docs series (#164, #165, #166, #168). It stands alone and is based on
main.Background
This reference page lists where
coderworkspacesandcodertemplatesbehave differently from usual Kubernetes resources: names, delete preconditions, the workspaceresourceVersion, watch, server-side apply, and template builds. Most rules are in passive sentences that do not say which component acts. The rewrite names the actor (the server, Coder, or Kubernetes).Implementation
main(checked with a script), so the anchors that other pages use still work.Validation
make docs-check(strict mkdocs build),markdownlint-cli20.18.1,cspell8.19.4, andlycheepass on the pushed commit.workspace.go,watch.go,identity.go). It found one must-fix item in my first draft: the reason for rejecting aliases read as a statement about current behavior. That is fixed, together with its optional wording fixes ("served from", "even when", an unclear "it").Before:
After:
Refs: no issue. Part of a plain-English docs pass.
Generated with
xum• Model:anthropic:claude-opus-5-5• Thinking:high