Skip to content

Expand README with task-focused crs-toolchain usage examples#312

Draft
fzipi with Copilot wants to merge 2 commits into
mainfrom
copilot/add-more-examples-to-documentation
Draft

Expand README with task-focused crs-toolchain usage examples#312
fzipi with Copilot wants to merge 2 commits into
mainfrom
copilot/add-more-examples-to-documentation

Conversation

Copilot AI commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

what

  • Added a new Usage Examples section to README.md to provide concrete command recipes beyond installation/self-update.
  • Structured examples as a quick command cookbook:
    • Regex workflow (generate, compare, format, update) including single-target, multi-target, stdin, and --all usage
    • Utility commands (fp-finder, renumber-tests) with practical flags (--extended-dictionary, --check, --all)
    • Chore commands (release, update-copyright, create-agenda)
    • CLI ergonomics (--directory, shell completion, GitHub-formatted output/log levels)
  • Included copy/paste-ready snippets, for example:
    crs-toolchain regex update 932100 933100-chain1.ra

why

  • The issue asked for substantially more usage examples in documentation; README previously lacked practical command coverage.
  • Grouped, runnable examples make common CRS maintenance workflows faster to discover and execute from the README alone.

references

  • Issue: Add more examples to documentation

Copilot AI linked an issue Jun 7, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add more examples to documentation Expand README with task-focused crs-toolchain usage examples Jun 7, 2026
Copilot finished work on behalf of fzipi June 7, 2026 12:55
Copilot AI requested a review from fzipi June 7, 2026 12:55
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.

Add more examples to documentation

2 participants