Skip to content

docs: refresh the README - #63

Merged
NovusEdge merged 1 commit into
mainfrom
docs/readme-refresh
Sep 5, 2026
Merged

NovusEdge merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@NovusEdge

Copy link
Copy Markdown
Owner

The command table still listed stoat provision, which #48 made a kong alias of apply, and omitted the commands #48 and #62 added.

  • apply replaces provision in the table, with --dry-run.
  • Adds stoat screenshot, stoat guest ls and stoat guest show.
  • Notes that every command takes --json.
  • "How it works" gains the recipe verb prelude and the guest.toml format, with a link to docs/reference/guest.md.
  • Adds a Contributing section pointing at CONTRIBUTING.md.

Docs only.

The command table listed provision, which is now an alias of apply, and omitted guest ls, guest show and screenshot. Adds the verb prelude and the guest.toml format to How it works, and points at CONTRIBUTING.

Signed-off-by: NovusEdge <novusedge0@gmail.com>
@NovusEdge NovusEdge added the documentation Improvements or additions to documentation label Sep 5, 2026
@NovusEdge NovusEdge self-assigned this Sep 5, 2026
@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 41 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Team

Run ID: db014d0c-4a0d-46f4-9c0c-ce48b100821f

📥 Commits

Reviewing files that changed from the base of the PR and between ad47b8c and 145a642.

📒 Files selected for processing (1)
  • README.md

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 5afe969 into main Sep 5, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant