docs: tidy per-crate READMEs onto a common structure#759
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis pull request adds comprehensive README.md documentation across 14 Pallas workspace crates. Each README introduces the crate's purpose, includes Rust usage examples, and lists key APIs and modules. Documentation establishes both foundational layers (codec, crypto, math) and higher-level APIs (transaction building, validation, networking). ChangesPallas Workspace Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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
🧹 Nitpick comments (2)
pallas-crypto/README.md (1)
3-7: ⚡ Quick winAdd an explicit
## Scopeheading for skeleton consistency.Line 3 currently acts as scope text, but adding a
## Scopeheader before it would align this README with the PR’s shared structure and keep crate docs uniformly scannable.Suggested diff
# Pallas Crypto +## Scope + Cryptographic primitives required to participate in the Cardano protocol: Blake2b hashing, Ed25519 signing (regular and BIP32-extended), VRF, KES forward-secure signatures, and nonce evolution. ## Usage🤖 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 `@pallas-crypto/README.md` around lines 3 - 7, Add an explicit "## Scope" heading above the existing scope text in README.md so the file matches the project's README skeleton; locate the top-level description starting with "Cryptographic primitives required to participate in the Cardano protocol..." and insert a new "## Scope" heading immediately before that paragraph to maintain uniform crate docs structure.pallas-network/README.md (1)
18-21: ⚡ Quick winAvoid hardcoding a live relay endpoint in the usage example.
Using a concrete host in docs can age poorly and break quick-start attempts. Prefer a placeholder (for example,
"<relay-host>:3001") plus a short note that the user must provide a reachable relay.🤖 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 `@pallas-network/README.md` around lines 18 - 21, The README usage example currently hardcodes a live relay host in the PeerClient::connect call; replace the literal "relays-new.cardano-mainnet.iohk.io:3001" with a placeholder like "<relay-host>:3001" and add a short note telling users to provide a reachable relay endpoint (and optionally set MAINNET_MAGIC) so examples stay valid and non-breaking.
🤖 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 `@pallas-network2/README.md`:
- Around line 14-25: The README example uses Manager::new, manager.poll_next(),
handle, and manager.execute(...) but references undeclared symbols (interface,
behavior, handle, my_external_command); either make the snippet self-contained
by adding minimal placeholders/types/closures for interface and behavior and a
stub handle function and my_external_command, or explicitly mark the block as
pseudocode/illustrative-only with a short comment so readers know to replace
those symbols before running; update the example around Manager, poll_next, and
execute accordingly.
---
Nitpick comments:
In `@pallas-crypto/README.md`:
- Around line 3-7: Add an explicit "## Scope" heading above the existing scope
text in README.md so the file matches the project's README skeleton; locate the
top-level description starting with "Cryptographic primitives required to
participate in the Cardano protocol..." and insert a new "## Scope" heading
immediately before that paragraph to maintain uniform crate docs structure.
In `@pallas-network/README.md`:
- Around line 18-21: The README usage example currently hardcodes a live relay
host in the PeerClient::connect call; replace the literal
"relays-new.cardano-mainnet.iohk.io:3001" with a placeholder like
"<relay-host>:3001" and add a short note telling users to provide a reachable
relay endpoint (and optionally set MAINNET_MAGIC) so examples stay valid and
non-breaking.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: afbc624e-4fbe-4eff-afdf-a9ab40ea09d5
📒 Files selected for processing (14)
pallas-addresses/README.mdpallas-bech32/README.mdpallas-codec/README.mdpallas-configs/README.mdpallas-crypto/README.mdpallas-hardano/README.mdpallas-math/README.mdpallas-network/README.mdpallas-network2/README.mdpallas-primitives/README.mdpallas-traverse/README.mdpallas-txbuilder/README.mdpallas-utxorpc/README.mdpallas-validate/README.md
1 participant
Summary
pallas-addresses,pallas-bech32,pallas-hardano,pallas-primitives,pallas-traverse,pallas-txbuilder) with real content.pallas-codec,pallas-crypto,pallas-math,pallas-network,pallas-network2,pallas-validate); fixes the malformed[]checklist inpallas-math.pallas-utxorpc,pallas-configs) onto the same skeleton with minimal content change.ShelleyAddress::network(),MultiEraOutput::lovelace_amount(),Input::new,BuiltTransaction::tx_bytes, etc.).Out of scope
README.md— deferred follow-up.pallas/crate — itsCargo.tomlsetsreadme = "../README.md", so it ships the root README; touching it belongs with the root-README pass.pallas-crypto/src/kes/README.md,pallas-validate/tests/README.md) — referenced from the new crate READMEs, not rewritten.Test plan
cargo doc --workspace --no-depssucceeds.pallas-network2andpallas-validate, which carry the most varied sections.cargo check(they aren't committed as doctests in this pass).Summary by CodeRabbit