docs(readme): refresh guides and add live demo - #73
Merged
Conversation
Signed-off-by: NovusEdge <novusedge0@gmail.com>
Signed-off-by: NovusEdge <novusedge0@gmail.com>
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
What changed
Describe Stoat as a terminal VM utility for people and AI agents. Shorten the README to an installation quickstart, one main TUI screenshot, and a video link. Refresh the installation, VM, project, recipe, MCP, and troubleshooting guides against the current CLI and source. Add real color Konsole captures and a 23-second recording that includes Alpine XFCE in QEMU.
Why
The documentation contained stale behavior claims and incomplete project and MCP guidance. The new guides describe current behavior and known limits, and the screenshots show real running guests.
Tests run
just checkandjust test: gofmt, vet, build, and the full Go test suiteFull check, lint, and shellcheck CI must pass before merge. The only change under
internal/is a correction to a sample TOML comment.Docs