Repository navigation
docs: rewrite the docs and code comments in ASD-STE100 - #7
Merged
Merged
Conversation
C77: CLAUDE.md in ASD-STE100. Every constraint, must-know and check keeps its fact; the Tick step list now names prepare as well. C75: the Constraints list gains one line that points to the Writing section of the org CONTRIBUTING, so an agent reads it before it writes.
C77: the README in ASD-STE100. "How it works" and "When something goes wrong" keep their headings, because other repos link to them. "Running it" and "Run your own" become "Operating it" and "Want your own?", the names the mirror READMEs use; nothing links to the old anchors. The secrets note becomes a caution. Code blocks keep their commands; only the comments in the task block change.
C78: every comment in the Go files, Taskfile.yml, Dockerfile, module.nix and flake.nix in ASD-STE100. Each comment keeps its place and its job, and Go doc comments still open with their names. No identifier, string or behavior changes: the Go token streams and the parsed Nix ASTs match origin/main. C63: Taskfile.yml, module.nix and flake.nix say "the host's flake", not the private repository's name.
Fix round 1 of the docs PR review. - COME, and WRITE, RECORD and WAIT as nouns: Tick is the subject, and "can follow" replaces "can come after" (review I-1, I-2). - The Tick step sequence is a numbered list; "contain" for file content; one wording for "the host gets a change" (minors 1, 3, 4). - Must knows: "each slot that had no run" (minor 2), the at-least-once note as a caution (minor 13), the retry lead names the second run (minor 14). - README: a /fail ping costs the slot only after a workflow start error; an error before the state is saved records no slot (controller ruling). - README: a fork also changes Org in main.go (controller ruling). - README: steps 2 and 5 of "Want your own?" as sub-steps (minor 6).
Fix round 1 of the docs PR review. Comments only: the Go token streams and the parsed Nix ASTs still match origin/main. - COME and the verb-only nouns: "follow", Tick as the subject, and "interval" for backoff (review I-1, I-2). - retryable: no "true" (adj); says when GitHub did not start the run (review I-3). - ping: two paragraphs, the "If not" sentence in full (review I-4). - Cadence: dropbox is "daily"; gnu and nongnu say "The scheduler starts it twice a day" (fact check, minor 9). - Minute: "decreases the load", not "cancels" (fact check). - runs task: any status other than completed has an empty conclusion (fact check). - flake.nix: an unambiguous ponytail trigger; no fragments (fact check, minor 11). - "contain" for content, "in one step" for atomically, the null comment on its own line, the schedules list before its warning, the GitHub file comment, the Dockerfile and task clean cautions (minors 3, 7, 8, 10, 12, 13, 15).
Fix round 2 of the docs PR review. - github.go: the file comment was one 30-word sentence. The four steps are now a numbered list (review N-1). - main.go: "ping sends the request to the URL" and "to /fail" (review N-2, optional). Comments only: the Go token streams still match origin/main.
Fix round 2 of the docs PR review (N-2, optional): one verb, "save", for the state write, as in the numbered steps.
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.
Consistency review, phase 5, for dispatch: C63, C75, C77 and C78.
How it works,When something goes wrong) are unchanged. "Running it" and "Run your own" become "Operating it" and "Want your own?", the mirrors' section names; nothing links to the old anchors./failping costs the slot only after a workflow-start error (an earlier error records no slot, and the next tick tries again), and a fork also changesOrgin main.go.Test plan
task check: gofmt, vet, tests pass