Add a concise Rook user guide - #19
Merged
Merged
Conversation
This was referenced Sep 9, 2026
samyakLambda
changed the title
Contributor
|
Reviewed the guide-relevant diff (docs/user-guide/README.md, headless-and-ci.md, troubleshooting.md). Content is correct and public-safe — no internal hostnames, secrets or private endpoints; only placeholder credentials and the localhost example. CI (scripts) is green. Holding (not merging) for two reasons: (1) this PR is still marked Draft, and (2) it depends on #18, which I just merged (sha 45bf00a). Please rebase/refresh this branch onto main and mark it Ready for review; the guide-only portion should then be reviewable on its own and I'm happy to approve and merge it. Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com |
samyakLambda
marked this pull request as ready for review
September 11, 2026 13:26
samyakLambda
force-pushed
the
docs/rook-user-guide
branch
from
September 11, 2026 13:26
4c3ef40 to
b316c6b
Compare
samyakLambda
requested review from
gauravBansal06 and
vipulkv
as code owners
September 11, 2026 13:26
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.
Add a three-page Rook guide: getting started, headless/CI use and troubleshooting. Link canonical references for detailed commands, profiles and verdicts. Use installed CLI help and required output fields across compatible releases, without an exact version requirement.
Validation: relative links/anchors, guide shell syntax and skill mirrors pass. Shared command checks pass on Rook 0.1.1 and 0.1.2.
Builds on #18 (merged). Rebased onto
mainon 2026-09-11; the branch now carries only the three guide commits. The npm installer lands separately in #20.