docs: add mdBook user manual - #41
Merged
Merged
Conversation
Adds the book/ mdBook covering installation, CLI flags, the configuration file, output formats, and every report metric, including the activity grid's granularity thresholds and the progress-indicator latency threshold. Deferred until after implementation so it documents real, verified behavior instead of the original spec's proposed shape.
WalkthroughAdds an mdBook for ChangesProject documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@book/src/usage/flags.md`:
- Line 6: Update the --relays option description in the flags reference to use
the grammatically correct “comma-separated” compound modifier, preserving the
existing relay fallback behavior text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: a293a692-64c1-4524-a4a3-a2b64d59b8c0
📒 Files selected for processing (15)
.gitignorebook/book.tomlbook/src/SUMMARY.mdbook/src/installation.mdbook/src/introduction.mdbook/src/metrics/README.mdbook/src/metrics/activity-grid.mdbook/src/metrics/context-signals.mdbook/src/metrics/disputes-bond-policy.mdbook/src/metrics/longevity-liveness.mdbook/src/metrics/trade-size-consistency.mdbook/src/output-formats.mdbook/src/usage/basic.mdbook/src/usage/config-file.mdbook/src/usage/flags.md
| | Flag | Description | | ||
| |---|---| | ||
| | `-p`, `--pubkey <PUBKEY>` | The node's public key to look up (npub or hex). Falls back to `MOSTRO_SCORE_PUBKEY`, then a saved configuration file. Not required with `--init-config`. | | ||
| | `-r`, `--relays <RELAYS>` | Nostr relays to query, comma separated. Falls back to `MOSTRO_SCORE_RELAYS`, then a saved configuration file, then the compiled-in default relay. | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use “comma-separated” in the relay description.
This is the grammatically correct compound modifier for the user-facing flag reference.
🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: Use a hyphen to join words.
Context: ...| Nostr relays to query, comma separated. Falls back toMOSTRO_SCORE_R...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@book/src/usage/flags.md` at line 6, Update the --relays option description in
the flags reference to use the grammatically correct “comma-separated” compound
modifier, preserving the existing relay fallback behavior text.
Source: Linters/SAST tools
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
1 participant
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.
Summary
Adds book/, an mdBook covering:
thresholds (90-day/730-day boundaries, reasoned from table row-count
practicality) and the progress-indicator's 3-second threshold (measured
from 3 real connect-and-fetch round trips)
Deferred until after Phase 4/5 implementation so it documents real, verified
behavior instead of the original spec's proposed shape.
Test plan
Summary by CodeRabbit