-
Notifications
You must be signed in to change notification settings - Fork 1
Fix documentation inaccuracies and reduce duplication #193
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.
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
Conversation
Co-authored-by: alexec <[email protected]>
Co-authored-by: alexec <[email protected]>
Co-authored-by: alexec <[email protected]>
Co-authored-by: alexec <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR corrects significant documentation inaccuracies and reduces duplication across documentation files. The primary fix addresses a false claim that task frontmatter appears in assembled context output - the code confirms that only task content is included. The PR also standardizes field naming from language (singular) to languages (plural) throughout documentation to match the typed field in the codebase, removes inconsistent slash prefix syntax from task examples, and consolidates duplicated content by linking to authoritative sources.
Key changes:
- Corrected task frontmatter behavior documentation (frontmatter used for filtering/metadata only, not included in output)
- Standardized to
languages:(plural) field naming throughout all documentation - Removed incorrect slash prefix from task name syntax (fix-bug instead of /fix-bug)
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/getting-started.md | Simplified installation instructions to reference README, clarified parameter vs selector flags, removed slash prefix from task names |
| docs/reference/file-formats.md | Corrected documentation stating task frontmatter is NOT included in output |
| docs/reference/cli.md | Updated output format documentation to reflect task frontmatter exclusion and correct skills metadata positioning |
| docs/how-to/use-selectors.md | Changed field name from language to languages, corrected frontmatter output expectations |
| docs/how-to/create-tasks.md | Clarified that task frontmatter is used for filtering but NOT included in output |
| docs/how-to/create-rules.md | Standardized field naming to languages: (plural) |
| SPECIFICATION.md | Updated all selector examples to use languages: instead of language: |
| README.md | Replaced duplicated search paths with link to reference docs, added comprehensive troubleshooting section |
Documentation incorrectly stated task frontmatter is included in output, used inconsistent field naming (
languagevslanguages), and had significant duplication across files.Fixed Inaccuracies
languages(plural) throughout. The code useslanguages: []as an array field—docs now match./fix-bug→fix-bug).Reduced Duplication
-p(parameters) vs-s(selectors) distinctionAdded Missing Content
task_namefield)Example Correction
Before:
After:
Files modified: 8 docs (+94/-73 lines)
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.