docs: lead the README with the concrete outcome and live examples - #11
Merged
Conversation
The opening described the tool abstractly ("turn code into a bespoke
interactive HTML lesson") and buried the example gallery below a prose
paragraph. For a product whose output *is* the pitch, the demo link should
be in the first three lines, not below the fold.
Also states the AI-tool dependency (Claude Code / Cursor / Codex) up front
instead of leaving readers to discover it in the Install section — better to
get credit for candor than to have someone feel misled after the demo.
Co-Authored-By: Claude Opus 5 <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
1 participant
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
Test plan
npm test— 18/18 passing (docs-only change, no behavior touched)🤖 Generated with Claude Code