Fix documentation inaccuracies and reduce duplication#193
Merged
Conversation
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Review documentation for inaccuracies and omissions
Fix documentation inaccuracies and reduce duplication
Dec 25, 2025
alexec
approved these changes
Dec 26, 2025
Contributor
There was a problem hiding this comment.
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 |
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.
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.