Skip to content

docs(readme): refresh guides and add live demo - #73

Merged
NovusEdge merged 2 commits into
mainfrom
codex/docs-live-showcase
Sep 6, 2026
Merged

docs(readme): refresh guides and add live demo#73
NovusEdge merged 2 commits into
mainfrom
codex/docs-live-showcase

Conversation

@NovusEdge

@NovusEdge NovusEdge commented Sep 6, 2026

Copy link
Copy Markdown
Owner

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 check and just test: gofmt, vet, build, and the full Go test suite
  • Live Alpine XFCE and Debian guests; SSH readiness and command execution; project lifecycle
  • 164 local documentation links, four TOML reference samples, and media inspection
  • Documentation and asset credential scan

Full check, lint, and shellcheck CI must pass before merge. The only change under internal/ is a correction to a sample TOML comment.

Docs

  • Documentation and navigation updated

Signed-off-by: NovusEdge <novusedge0@gmail.com>
Signed-off-by: NovusEdge <novusedge0@gmail.com>
@coderabbitai

coderabbitai Bot commented Sep 6, 2026

Copy link
Copy Markdown

Review Change Stack

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-live-showcase

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@NovusEdge
NovusEdge merged commit a51fa31 into main Sep 6, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant