docs: add hands-on CLI tutorial#25
Merged
Merged
Conversation
Add docs/user/cli-tutorial.md — a 10-minute walkthrough of `qestyle` on a real lecture (the test-action-style-guide markov_chains_jax.md, seeded with 42 catalogued violations): dry-run, read the report, apply fixes, inspect the diff, and measure recall against the catalog. Includes a copy-paste demo cheat-sheet for live screen-shares, and links to the pre-executed examples/ output as a no-API-key fallback. Wire it into the MyST TOC and cross-link from the CLI reference and README. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR expands the user documentation by adding a hands-on qestyle CLI tutorial intended to be both a quick-start walkthrough and a live-demo script, and then wires it into the docs navigation and existing CLI docs entry points.
Changes:
- Add a new
docs/user/cli-tutorial.mdpage with an end-to-end, copy/paste-friendly walkthrough (dry-run → report → apply fixes →git diff→ recall measurement). - Cross-link the tutorial from the existing CLI reference page and the top-level README.
- Include the tutorial in the MyST docs TOC (
docs/myst.yml) so it renders in the published site navigation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Adds a link to the new CLI tutorial in the User Guide list. |
| docs/user/cli.md | Adds a tip box pointing new users to the tutorial. |
| docs/user/cli-tutorial.md | Introduces the new hands-on CLI tutorial + demo cheat-sheet content. |
| docs/myst.yml | Adds the tutorial page to the documentation TOC. |
- Portable editor commands (note macOS `open` / Linux `xdg-open`) - Clarify recall wording: '27 of the 30 rules seeded in the catalog' - Show the printed report path as absolute (CLI resolves the path) - Add companion page cli-tutorial-output.md (console output + diff + recall), folded from the test repo so the CLI sample lives with the CLI docs; point the tutorial's fallback note at it. Keeps test-action-style-guide for the Action demo. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Summary
Adds a hands-on CLI tutorial to the docs — a ~10-minute walkthrough of
qestyleon a real lecture, which doubles as a live-demo script.docs/user/cli-tutorial.md: dry-run → read the report → apply fixes →git diff→ measure recall vs the 42-violation catalogtest-action-style-guide/examples/(full report + applied diff + recall analysis) as a no-API-key fallbackdocs/myst.ymlTOC; cross-linked fromcli.mdandREADME.mdVerification
mystmd build --htmlbuilds cleanly;/cli-tutorialrenders and the cheat-sheet anchor resolves (no implicit-reference warning).🤖 Generated with Claude Code