This document provides a complete index of all documentation files in the CardioEquation project. Use this as a navigation guide to find the information you need.
- Start here: README.md - Project overview and quick start
- Quick demo: docs/QUICKSTART.md - 30-second introduction
- Deep dive: PROJECT_OVERVIEW.md - Complete project journey
- CONTRIBUTING.md - How to contribute
- CODE_OF_CONDUCT.md - Community standards
- .github/PULL_REQUEST_TEMPLATE.md - PR template
- CITATION.cff - How to cite this project
- docs/NEXT_STEPS.md - Development roadmap
| File | Purpose | Audience | Last Updated |
|---|---|---|---|
| README.md | Main project documentation | All users | Jan 2026 |
| PROJECT_OVERVIEW.md | Comprehensive project journey | Stakeholders, new contributors | Jan 2026 |
| LICENSE | MIT License with disclaimers | Legal, users | Jan 2026 |
| CONTRIBUTING.md | Contribution guidelines | Contributors | Jan 2026 |
| CODE_OF_CONDUCT.md | Community standards | All participants | Jan 2026 |
| CHANGELOG.md | Version history | Users, developers | Jan 2026 |
| SECURITY.md | Security policies | Security researchers | Jan 2026 |
| CITATION.cff | Academic citation info | Researchers | Jan 2026 |
| AUTHORS.md | Contributor recognition | Contributors | Jan 2026 |
| DOCUMENTATION_INDEX.md | This file - navigation guide | All users | Jan 2026 |
- README.md - Overview, features, quick start
- PROJECT_OVERVIEW.md - Complete development journey
- docs/QUICKSTART.md - Quick start guide
- CHANGELOG.md - What's changed in each version
- CONTRIBUTING.md - How to contribute
- CODE_OF_CONDUCT.md - Community standards
- AUTHORS.md - Contributors list
- .github/PULL_REQUEST_TEMPLATE.md - PR template
- LICENSE - MIT License with disclaimers
- SECURITY.md - Security policies and reporting
- CITATION.cff - Citation information
- docs/NEXT_STEPS.md - Development roadmap
- docs/DEMO_GUIDE.md - Interactive demo guide
| Question | Document | Section |
|---|---|---|
| What is CardioEquation? | README.md | Overview |
| How do I install it? | README.md | Getting Started |
| How do I contribute? | CONTRIBUTING.md | All sections |
| How do I cite it? | CITATION.cff, PROJECT_OVERVIEW.md | Citing section |
| What's the license? | LICENSE | All |
| Is it safe to use? | SECURITY.md | All sections |
| What's the roadmap? | docs/NEXT_STEPS.md, CHANGELOG.md | Future plans |
| How does it work technically? | PROJECT_OVERVIEW.md | Architecture |
| What are the results? | PROJECT_OVERVIEW.md | Performance |
This documentation index is maintained by the CardioEquation team.
Last Updated: January 2026
Version: 2.1
Maintainer: CardioEquation Team