Home / Docs / Documentation Overview & Guide Index

Documentation Overview & Guide Index

stable profile: index

User guide entry point, topics directory, and learning path for Open Document Spec.

Documentation Guide

Welcome to the Open Document Spec (ODS) User Guide. Choose a topic below to get started:

  • Introduction: Core design principles, Level 0–3 adoption ladder, learning path, and benefits.
  • Quickstart Guide: Skill-first setup, workspace initialization, service background daemon, validation, and AI context.
  • Adopting ODS: Enriching existing Markdown repositories progressively without migration overhead.
  • Tooling Reference: Complete CLI command reference, daemon execution modes, code references, and CI integration.
  • Profiles & Catalogs: Standard profiles, custom profile catalogs, resolution precedence, and ODS Packs.
  • Advanced Workspaces: AI agent reading order, global multi-workspace tracking, daemon memory tuning, and large workspaces.
  • Troubleshooting & Diagnostics: Diagnostic workflow, complete error catalog for ods-error.md, git merge conflicts, and daemon troubleshooting.
  • Enterprise Deployment: Enterprise ODS Pack distribution, multi-repo governance, CI/CD pipelines, security controls, and ROI modeling.
  • FAQ & Troubleshooting: Frequently asked questions about file extensions, adoption, profiles vs tags, renames, and background services.
  • Features: Complete reference for frontmatter keys, root index configuration, profiles vs packs, AI context, and CLI commands.
  • ROI Calculator: Quantifying context reduction, token savings, and ROI with ODS.