Skip to content

Restructure README and add docs#140

Merged
kwsantiago merged 1 commit into
mainfrom
docs/restructure-readme
Mar 13, 2026
Merged

Restructure README and add docs#140
kwsantiago merged 1 commit into
mainfrom
docs/restructure-readme

Conversation

@kwsantiago
Copy link
Copy Markdown
Contributor

@kwsantiago kwsantiago commented Mar 13, 2026

Summary

  • Shorten README to match keep's style: centered title, about, features, quick start, dev, security, license
  • Move detailed content to docs/USAGE.md (prerequisites, build, JSON-RPC API, Bitcoin PSBT, policy, DKG, testing)
  • Add docs/SECURITY.md (air-gapped design, threshold signing, secure boot reference)
  • Add docs/REPRODUCIBILITY.md (Docker build, hash/release/device verification)

Summary by CodeRabbit

  • Documentation
    • Restructured README with new About section and Features list highlighting cryptographic capabilities and security design.
    • Added three comprehensive documentation files covering reproducible builds, security architecture, and detailed usage instructions.
    • Consolidated and reorganized content for improved clarity and accessibility.

@kwsantiago kwsantiago merged commit 31dce3c into main Mar 13, 2026
8 of 9 checks passed
@kwsantiago kwsantiago deleted the docs/restructure-readme branch March 13, 2026 16:52
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 13, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8b0971ac-47aa-4d29-ac55-aa865df36f48

📥 Commits

Reviewing files that changed from the base of the PR and between 4212008 and cad4643.

📒 Files selected for processing (4)
  • README.md
  • docs/REPRODUCIBILITY.md
  • docs/SECURITY.md
  • docs/USAGE.md

Walkthrough

This PR restructures project documentation by consolidating README content into purpose-built guides. It reduces the README through reorganization and consolidates build, usage, security, and reproducibility information into separate external documentation files.

Changes

Cohort / File(s) Summary
README Restructuring
README.md
Reworked structure with new About and Features sections; consolidated build, usage, API, and testing content into references to external docs; streamlined Development section.
New Documentation Files
docs/REPRODUCIBILITY.md, docs/SECURITY.md, docs/USAGE.md
Added comprehensive guides: REPRODUCIBILITY.md covers reproducible build practices and verification; SECURITY.md documents air-gapped design, threshold signing, and secure boot; USAGE.md provides complete CLI usage, setup, Bitcoin PSBT signing, DKG, JSON-RPC API reference, and testing procedures.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

📚✨ A rabbit's ode to clearer paths ahead:
Documentation blooms where README led,
Each guide now stands tall and pristine,
Security, usage, reproducibility—a dream!
Hopping through docs, no confusion found 🐰

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/restructure-readme
📝 Coding Plan
  • Generate coding plan for human review comments

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.

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