docs: cover doctor on the human-facing surfaces (README, README.ja, llms.txt) - #661
Open
fujibee wants to merge 2 commits into
Open
docs: cover doctor on the human-facing surfaces (README, README.ja, llms.txt)#661fujibee wants to merge 2 commits into
fujibee wants to merge 2 commits into
Conversation
…lms.txt) scripts/doctor.sh shipped (#640/#654) with the agent-facing surfaces handled separately, but the three human-facing files that describe the other subcommands never mention it: README.md and README.ja.md have per-subcommand sections (spawn, despawn, actas) and no doctor section, and llms.txt enumerates scripts/*.sh under "Key source files" without scripts/doctor.sh. Add a doctor section to README.md matching the granularity of the surrounding subcommand sections: bare doctor as the normal form (whole-installation default), --project/--type/--team as freely combinable narrowing filters, --redacted as the paste-into-an-issue form, read-only stance, and the 0/1/2 exit codes. README.ja.md gets the same section as a translation of the English text. llms.txt gets one doctor.sh line in the existing list format. Descriptions were checked against doctor.sh --help, the script, and tests/test_doctor.bats rather than restated from memory.
…g no leaks _redact_project collapses a $HOME-prefixed path to ~ and pseudonymizes only paths outside $HOME (doctor.sh line 261; fixed by tests/test_doctor.bats lines 317/346). The username disappears, but the directory structure below $HOME stays visible -- and most projects live under $HOME. "Without leaking your machine's layout" promised more than the majority case delivers, and the sentence sits exactly on the paste-into-a-public-issue path. Say what is hidden ($HOME prefix, outside-$HOME paths, team/agent names) and what remains (path segments below $HOME), and tell the reader to skim the output before posting. Same change in README.ja.md, translated from the corrected English.
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.
doctorshipped in #640/#654, and the agent-facing surfaces (type templates, dispatch, SKILL.md) are being covered in #660 — but the three human-facing files that describe the other subcommands never mention it: README.md and README.ja.md have a per-subcommand section for spawn/despawn/actas and none for doctor (the string does not appear in either file), and llms.txt enumeratesscripts/*.shunder "Key source files" withoutscripts/doctor.sh.Changes
### See who holds what (doctor)section, placed with the other subcommand sections (after session resume, before Delivery modes). It keeps baredoctoras the normal form — whole-installation default, likeclaude doctor/brew doctor— with--project/--type/--teampresented as freely combinable narrowing filters rather than required scoping,--redactedas the paste-into-an-issue form (consistent pseudonyms for paths and names), the read-only stance (stale state is reported, never cleaned up), and the0/1/2exit codes.scripts/doctor.shline added to the "Key source files" list in the existing format.Descriptions were verified against
scripts/doctor.sh --help, the script itself, andtests/test_doctor.bats(default scope, filter combination, redaction shape, exit codes) rather than restated from other summaries.Docs-only; no scripts or tests are touched.