Project Myriad - Documentation Index

This document serves as a navigation guide for all Project Myriad documentation, helping you find the information you need quickly and efficiently.

📋 Quick Reference

Document Purpose Target Audience
README.md Project overview, features, quick start All users, potential contributors
ARCHITECTURE.md Complete architecture documentation Developers, architects
DEVELOPMENT.md Development setup and coding guidelines Contributors, developers
CONTRIBUTING.md Contribution guidelines and standards New contributors

📚 Documentation Structure

Getting Started

Start here if you’re new to Project Myriad:

  1. README.md - Get an overview of what Project Myriad is and its core features
  2. DEVELOPMENT.md - Set up your development environment
  3. CONTRIBUTING.md - Learn how to contribute to the project

Architecture & Design

For understanding the technical architecture:

  • ARCHITECTURE.md - Complete architecture documentation (authoritative source)
  • ROADMAP.md - Current implementation status and development phases

Requirements & Specifications

For detailed technical requirements:

Development Resources

For active development work:

Feature Documentation

For specific features and implementations:

Project Management

For project planning and roadmap:

Policies & Guidelines

For project governance:

  • SECURITY.md - Security policies and vulnerability reporting
  • LICENSE - Project license terms

🎯 Common Tasks

I want to…

Get started with the project → Start with README.md, then DEVELOPMENT.md

Understand the architecture → Read ARCHITECTURE.md (authoritative source for all architecture info)

Set up development environment → Follow DEVELOPMENT.md setup instructions

Contribute to the project → Review CONTRIBUTING.md and DEVELOPMENT.md

Understand technical requirements → See requirements.md for comprehensive specifications

Learn about specific features → Check feature-specific docs in the Feature Documentation section

Build the project → See comprehensive build instructions in DEVELOPMENT.md

Report security issues → Follow guidelines in SECURITY.md

Understand dependencies → Review dependency-management.md

📖 Documentation Principles

Single Source of Truth

Each piece of information has a primary location to avoid duplication:

Cross-References

Documents reference each other rather than duplicating information:

  • High-level overviews link to detailed documentation
  • Detailed docs reference related concepts
  • Clear navigation between related topics

Audience-Specific Organization

  • README.md - Accessible to all users, provides overview and navigation
  • ARCHITECTURE.md - Technical details for developers and architects
  • DEVELOPMENT.md - Practical information for active contributors
  • requirements.md - Comprehensive specifications for detailed analysis

🔄 Maintenance

This documentation index is maintained alongside the project and updated when:

  • New documentation is added
  • Document purposes or audiences change
  • Navigation structure is modified

For documentation issues or suggestions, please open an issue in the project repository.

🌐 Online Documentation

For the best browsing experience, visit our GitHub Pages Documentation Site which includes:

  • 📖 All documentation with improved navigation
  • 🔍 Full-text search capabilities
  • 📚 Interactive API documentation
  • 🎨 Enhanced visual presentation

This index ensures that Project Myriad’s comprehensive documentation remains organized, accessible, and maintainable.

Last updated: December 2024 - Major documentation refresh with current technology stack and production-ready status