Repository navigation
docs(readme): add a first run, the nav line and the banner credit - #28
Merged
Merged
Conversation
Add a First run section with clone and install steps and the expected start of `ghostsoap plan --pack start-here` (checked against a release build of main), so readers no longer start at `ghostsoap init` with no install step. Add the brand navigation line, credit the banner fonts (Cascadia Mono and Besley) and write '2 years' as a numeral.
EquityBot
enabled auto-merge (squash)
November 2, 2026 01:04
|
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
✅ No blocking issues noticed
No blocking findings were identified. The documented first-run flow, navigation links, and sample output still lack automated validation coverage.
Test suggestions
- Validate that the first-run commands work from a fresh clone and that planning requires no profile or network transmission.
- Verify that each navigation link resolves to an existing README heading.
- Verify that the documented sample output matches the first entry produced by the command.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Validate that the first-run commands work from a fresh clone and that planning requires no profile or network transmission.
2. Verify that each navigation link resolves to an existing README heading.
3. Verify that the documented sample output matches the first entry produced by the command.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
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.
README additions for a first-time reader.
ghostsoap initwith no install step. The new section gives the clone andcargo installsteps, thenghostsoap plan --pack start-here, which needs no profile and sends nothing, with the start of its output. Checked against a release build of main (ea465d8): the sample matches the first entry exactly. Originally written on 31 October as 713e107 and held until the history rewrite.No code changes.