docs: rewrite README for clarity and structure#236
Merged
Conversation
Reorder so Requirements/Install come before the workflow narrative, add a "How The Pieces Fit Together" overview (two flows + architecture + file roles), collapse redundant demo/build/edit sections into Project Flow and One-Shot Media Commands, and merge Native Goal Mode into Agent Workflows. Trims duplication with docs/projects.md while keeping the npm package-name warning, media embeds, and showcase links intact. Adds the readme-writer Claude agent used to produce this rewrite.
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
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.
Reorder so Requirements/Install come before the workflow narrative, add a
"How The Pieces Fit Together" overview (two flows + architecture + file
roles), collapse redundant demo/build/edit sections into Project Flow and
One-Shot Media Commands, and merge Native Goal Mode into Agent Workflows.
Trims duplication with docs/projects.md while keeping the npm package-name
warning, media embeds, and showcase links intact.
Adds the readme-writer Claude agent used to produce this rewrite.