Skip to content

docs: verify and fix documentation against code implementation#135

Merged
alexec merged 2 commits into
mainfrom
docs/verify-and-fix-documentation
Dec 2, 2025
Merged

docs: verify and fix documentation against code implementation#135
alexec merged 2 commits into
mainfrom
docs/verify-and-fix-documentation

Conversation

@alexec
Copy link
Copy Markdown
Contributor

@alexec alexec commented Dec 2, 2025

Summary

This PR verifies and fixes documentation discrepancies found when comparing documentation against the actual code implementation.

Changes

  • Task matching: Fixed documentation to clarify tasks are matched by filename (without .md extension), not by task_name in frontmatter
  • Removed -t flag: Removed all references to non-existent -t flag for conditionally emitting task frontmatter
  • Language field: Clarified that language/languages field in task frontmatter is metadata only and does NOT filter rules
  • Consistent plural usage: Updated all examples to use languages: (plural) with array format [ go ] instead of singular language: go
  • Selector consistency: Updated all selector references to use languages (plural) - both in frontmatter selectors and command-line flags (-s languages=go)
  • Frontmatter emission: Clarified that task frontmatter is always automatically included when present
  • Task name requirement: Updated to clarify task_name is optional (metadata only), tasks are matched by filename

Files Changed

  • All documentation files in docs/ directory
  • README.md

Testing

  • All tests pass
  • Linting passes with no deadcode found

alexec and others added 2 commits December 1, 2025 21:59
- Fix task matching documentation (tasks matched by filename, not task_name)
- Remove non-existent -t flag documentation
- Clarify language field is metadata only, not a selector
- Update all examples to use languages (plural) with array format
- Update all selector references to use languages (plural)
- Clarify task frontmatter is always emitted
- Update task_name to be optional (metadata only)
@alexec alexec marked this pull request as ready for review December 2, 2025 06:00
@alexec alexec enabled auto-merge (squash) December 2, 2025 06:00
@alexec alexec merged commit 3eb72ed into main Dec 2, 2025
1 check passed
@alexec alexec deleted the docs/verify-and-fix-documentation branch December 2, 2025 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant