Skip to content

docs: expand root readme with quickstart and missing crates#760

Merged
scarmuega merged 9 commits into
mainfrom
docs/refresh-root-readme
May 8, 2026
Merged

docs: expand root readme with quickstart and missing crates#760
scarmuega merged 9 commits into
mainfrom
docs/refresh-root-readme

Conversation

@scarmuega
Copy link
Copy Markdown
Member

@scarmuega scarmuega commented May 8, 2026

Summary

Refreshes the root README.md with content the workspace had outgrown:

  • Fix logo image URLs (mastermain).
  • Add the four published crates that were missing from the Unboxing tables: pallas-bech32, pallas-configs, pallas-network2, pallas-validate.
  • Add a one-line note in the Network section explaining pallas-network2 is a P2P-focused rewrite of pallas-network.
  • Add a Getting Started section with cargo add snippets and a pointer to examples/.
  • Add a Features section documenting the umbrella crate's Cargo features (hardano, phase2, network2, relaxed, unstable).

No changes to per-crate READMEs (those are tracked separately on docs/tidy-per-crate-readmes).

Test plan

  • GitHub renders the README correctly (logo loads from main, tables align).
  • All relative crate links (/pallas-bech32, /pallas-network2, etc.) resolve.
  • The cargo add snippets are copy-pasteable.
  • The feature table matches pallas/Cargo.toml [features].

Summary by CodeRabbit

Release Notes

  • Documentation
    • Reorganized README with a new "Getting Started" section providing clearer guidance on using the umbrella crate and understanding the dependency structure.
    • Added a comprehensive feature table and crate catalog organized by domain for easier navigation.
    • Introduced an "Examples" section showcasing available runnable example projects.
    • Added "Cardano Era Compatibility" section detailing supported eras and coverage.
    • Updated asset references for improved reliability.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

Warning

Rate limit exceeded

@scarmuega has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 7 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: df60f33c-922c-40e4-a9b9-5932af055c7a

📥 Commits

Reviewing files that changed from the base of the PR and between c028a0d and e267a2e.

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

Walkthrough

The README is reorganized with new foundational sections: header URLs updated to the main branch, a "Getting Started" section introducing the umbrella crate and feature matrix, reorganized crate catalogs by domain (Core, Network, Ledger, Tx Builder, Interop) with additional entries, an "Examples" section with runnable references, and a "Cardano Era Compatibility" section documenting supported eras.

Changes

Documentation Expansion

Layer / File(s) Summary
Header and Branding
README.md
Logo image and source URLs updated from master to main branch references.
Getting Started Guide
README.md
New section with umbrella crate usage guidance, ASCII module re-export tree, and Cargo features table (hardano, phase2, network2, relaxed, unstable).
Crate Reference Catalog
README.md
Replaced "Unboxing" section with domain-organized crate listing (Core, Network, Ledger, Tx Builder, Interop) including new crates: pallas-bech32, pallas-configs, pallas-validate, pallas-network2, pallas-addresses.
Examples Section
README.md
New table linking to and describing multiple runnable example directories.
Cardano Era Compatibility
README.md
New section documenting era support from Byron through Conway, roles of pallas-primitives and pallas-traverse, with per-era notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A readme awakens with new structure and light,
From master to main, the logos burn bright,
Era tables and features, examples galore,
The crates now organized, users adore! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main changes: expanding the README with quickstart guidance and documenting previously omitted crates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refresh-root-readme

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 and usage tips.

@scarmuega scarmuega force-pushed the docs/refresh-root-readme branch from 1ce1563 to e267a2e Compare May 8, 2026 16:13
@scarmuega scarmuega merged commit 56253ba into main May 8, 2026
15 checks passed
@scarmuega scarmuega deleted the docs/refresh-root-readme branch May 8, 2026 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant