Documentation
README
Glimpse Changes
Render a Markdown walkthrough in a native Glimpse window with syntax-highlighted code and rich diff rendering.
Setup
npx glimpse-changes@1.9.5 --help
How to write a useful walkthrough
Use Glimpse to walk another developer through the code in the clearest order, not necessarily the order files appear in the diff.
Aim for a short, reviewable document:
- Start with a specific title.
- Add a brief summary of what changed.
- Choose the walkthrough order that best explains the work.
- Use prose between focused
changesordiffblocks to explain intent, tradeoffs, and review risks.
This is the opening of the README. Read the full README on GitHub.