Skip to content

Add concise documentation guidance to usethis-cli-modify skill #1578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 2 commits into from
Mar 27, 2026
Merged

Add concise documentation guidance to usethis-cli-modify skill #1578

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b396dfc
Initial plan
Copilot Mar 27, 2026
1e4c8cc
Add concise documentation guidance to usethis-cli-modify skill
Copilot Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .agents/skills/usethis-cli-modify/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Modify the usethis CLI layer (commands, options, help text) and kee
compatibility: usethis, Python, typer, markdown
license: MIT
metadata:
version: "1.0"
version: "1.1"
---

# Modifying the CLI
Expand Down Expand Up @@ -34,6 +34,20 @@ After making CLI changes, review and update each of the following as needed:

The command reference page documents every command with its full description, supported options, and behavior. Update it to match any changes you made to commands, options, defaults, or descriptions.

Keep descriptions **factual and concise**. The reference is not the place for extended rationale, usage tips, or explanations of why an option exists. If important context is needed, put it in a separate documentation page and link to it from the reference.

Good — factual, concise:

```markdown
- `--output-file` to write the output to a file instead of stdout.
```

Bad — excessive rationale embedded in the reference:

```markdown
- `--output-file` to write the output to a file instead of stdout. This is useful to avoid issues when shell redirects (e.g. `> file.txt`) create the file before the command runs, which can influence the behaviour of `usethis show`.
```

### Command overview

The command overview page lists all commands organized by category with brief descriptions. Update it if you added, removed, renamed, or recategorized a command.
Expand Down