Start here
The README is the front door. The architecture document is the map. The PRD explains what is done and what is not.
README
What the repository is, how the surfaces fit together, local setup, tests, deployment and the documentation index.
Open README ↗ ArchitectureArchitecture & Mermaid diagrams
System context, published surfaces, app runtime, offline licensing, Miraiva trust boundaries and the CI/CD pipeline.
Open architecture ↗ ProductPlatform PRD
Personas, goals and non-goals, numbered requirements with statuses, success metrics, gaps, roadmap and definition of done.
Open PRD ↗Catalogue and product docs
The catalogue is generated from the same in-page array that renders the hub, so counts and links cannot drift.
App catalogue
All 64 tools with category, free tier, paid pack and price. Regenerate with node tools/gen-app-catalog.mjs.
Product & capabilities index
Every page, app and product (104): PRD summary, capabilities, use cases, epics and user stories with statuses, plus prioritised cross-site findings.
Open index ↗ HealthMiraiva PRD
Phased requirements for the consent-first family health wallet, including ABDM boundaries and production gates.
Open Miraiva PRD ↗ Live productMiraiva portal
What is real, simulated and synthetic, plus the health architecture, data model and operations views.
Open health portal → ToolingOwner tools
The pre-ship gate, site link checker, checkout wiring, licence minting and catalogue generation. Not published as products.
Open tools README ↗Working on the repository
Every app is one HTML file plus a README and a ship declaration. The gate checks the couplings between an app and the rest of the site.
Contributing
Branch, build, test and ship an app or a platform change, including the definition of done.
Open contributing ↗ TrustSecurity policy
How to report a vulnerability, what is in scope, and the limits of client-side paid-content protection.
Open security policy ↗ OperationsDeployment guide
GitHub Pages setup, the health build, custom domain and troubleshooting.
Open deployment guide ↗Document map
| Document | Audience | Answers |
|---|---|---|
| README.md | Everyone | What is this, how do I run it, where is everything? |
| docs/ARCHITECTURE.md | Engineers | How does it work, where are the trust boundaries, how does it deploy? |
| docs/PRD.md | Product / maintainers | Who is it for, what is required, what is shipped, what is next? |
| docs/APP_CATALOG.md | Buyers / maintainers | Which tools exist, what is free, what does the paid pack add? |
| docs/product-index/ | Product / maintainers | What does each product do, for whom, which epics and stories are done, partial or pending, and what needs fixing? |
| MIRAIVA_PRD.md | Health product team | What are the health phases, gates and acceptance criteria? |
| BUILD_TRACKER.md | Maintainers | What did the original 50-app programme decide, and why? |
| CONTRIBUTING.md | Contributors | How do I add a tool or a platform change safely? |
| SECURITY.md | Security researchers | How do I report an issue, and what is in scope? |
Mermaid diagrams render directly in GitHub's file view. If you are reading the raw Markdown elsewhere, paste the diagram block into any Mermaid renderer; the source is plain text in the repository.