Add concise documentation guidance to usethis-cli-modify skill#1578
Merged
nathanjmcdougall merged 2 commits intomainfrom Mar 27, 2026
Merged
Add concise documentation guidance to usethis-cli-modify skill#1578nathanjmcdougall merged 2 commits intomainfrom
nathanjmcdougall merged 2 commits intomainfrom
Conversation
Update the CLI-modify skill to instruct agents to keep CLI reference descriptions factual and concise, with good/bad examples. Excessive context should go in separate docs pages with hyperlinks. Bump version 1.0 → 1.1. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/517920b8-ff45-471d-9695-dced32db9c56 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix documentation in CLI reference by removing excessive detail
Add concise documentation guidance to usethis-cli-modify skill
Mar 27, 2026
nathanjmcdougall
approved these changes
Mar 27, 2026
nathanjmcdougall
deleted the
copilot/remove-excessive-detail-cli-reference
branch
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.
Agents were embedding excessive rationale in CLI reference docs (seen in #1565). The
usethis-cli-modifyskill lacked guidance on documentation style.1.0→1.1The guidance distinguishes between factual reference entries and context that belongs in separate pages:
⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.