Skip to content

Latest commit

 

History

History
119 lines (88 loc) · 6.11 KB

DOCS.md

File metadata and controls

119 lines (88 loc) · 6.11 KB

Documentation Index

The docs/ directory is a git submodule. If it appears empty after cloning, run:

git submodule update --init --recursive

This index maps all 27 subdirectories inside docs/ so you can find what you need without browsing blindly.


Getting Started

Directory Contents
docs/getting-started/ Onboarding guides, first-run checklists, environment setup
docs/quickstart.mdx Fuma Docs quickstart page
docs/index.mdx Fuma Docs landing page

Architecture & Design

Directory Contents
docs/architecture/ System design documents, component diagrams, data flow
docs/adr/ Architecture Decision Records (ADRs)
docs/concepts/ Core domain concepts and mental models
docs/platform/ Platform-level design and infrastructure docs
docs/rfc/ Request for Comments — proposed changes and specifications

API & Reference

Directory Contents
docs/api/ API design docs and OpenAPI specs
docs/api-reference/ Auto-generated API reference
docs/reference/ General reference material and cheat sheets

Development

Directory Contents
docs/developers/ Developer guides, coding standards, contribution workflows
docs/guides/ Step-by-step tutorials for common tasks
docs/database/ Schema docs, migration guides, ER diagrams

Compliance & Security

Directory Contents
docs/compliance/ HIPAA, GDPR, regulatory compliance frameworks
docs/clinical-validity/ Clinical evaluation protocols and validation studies
docs/SECURITY.md Security policies and incident response
docs/THREAT_MODEL.md Threat model and attack surface analysis

Operations

Directory Contents
docs/operations/ Runbooks, deployment procedures, SRE guides
docs/runbooks/ Incident response and operational runbooks
docs/plans/ Roadmaps, sprint plans, and project tracking

Knowledge & Memory

Directory Contents
docs/knowledge/ Knowledge base articles and domain expertise
docs/memory/ Memory system architecture and Foresight MCP docs
docs/product/ Product specs, PRDs, and feature requirements

Enterprise & Tooling

Directory Contents
docs/enterprise/ Enterprise deployment and integration guides
docs/linear-audit/ Linear workspace audit ETL pipeline (data quality)
docs/superpowers/ Advanced usage patterns and power-user features

Additional

Directory Contents
docs/products/ Product catalog and comparison docs
docs/images/ Image assets used in documentation
docs/logo/ Logo files and brand assets
docs/tests/ Documentation test fixtures and snapshots

Fuma Docs

The docs/ submodule uses Fuma Docs for its documentation portal. The configuration lives in docs/docs.json. To serve locally:

cd docs
uv pip install -e ".[dev]"
# Follow Fuma Docs CLI instructions in docs/docs.json

Key Files

File Purpose
docs/README.md Docs submodule README (Linear audit pipeline focus)
docs/TRUTH.md Source-of-truth principles and data integrity rules
docs/LICENSE Documentation license (MIT)


© 2026 Pixelated Empathy. All rights reserved.