docs: refresh README with visual demo assets#123
Merged
Conversation
Improve README readability and GitHub rendering by restructuring sections, adding demo and workflow images, and clarifying quickstart guidance.
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
2 participants
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.
Improve README readability and GitHub rendering by restructuring sections, adding demo and workflow images, and clarifying quickstart guidance.
Summary
Revamp README.md structure for clearer onboarding and architecture narrative
Replace fragile ASCII workflow rendering with image-based visualization (workflow.png, node.png)
Add demo assets (demo.gif, demo.mp4) and update demo section for stable GitHub rendering
Validation
make checkpassed, or skipped checks are listed belowmake compose-configpassed when Docker/Compose config changedNotes
Call out migrations, breaking changes, follow-up work, or known limitations.