Sintesi

The intelligent documentation engine.

Sintesi guarantees your documentation never drifts from your codebase. It uses multi-agent AI and RAG to analyze your source code, plan a documentation structure, and write comprehensive, up-to-date docs. No outdated wikis, no "docs rot".

---

⚡️ Why Sintesi?

Traditional documentation often becomes outdated. Sintesi keeps your docs fresh and relevant.

• 🛡️ Drift Protection: Detects inconsistencies between code and documentation before you merge.
• 🕵️ Context-Aware: Reads your actual source code to write specific, accurate documentation.
• 🤖 Multi-Agent: Utilizes specialized agents (Planner, Writer, Reviewer, and Researcher) to produce high-quality content.
• 📦 Monorepo Native: Designed for complex workspaces from day one, allowing seamless integration in monorepo environments.

🚀 Quick Start

You can integrate Sintesi into your CI/CD pipeline or use it locally.

Add a new workflow in .github/workflows/sintesi.yml:

name: Sintesi - Documentation AI
on:
    push:
        branches: [main]

concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}
    cancel-in-progress: true

permissions:
    contents: write
    pull-requests: write

jobs:
    sync-docs:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
              with:
                  fetch-depth: 0

            - name: Sintesi Check & Fix
              uses: doctypedev/action@v0
              with:
                  openai_api_key: ${{ secrets.OPENAI_API_KEY }}
                  cohere_api_key: ${{ secrets.COHERE_API_KEY }} # Add COHERE_API_KEY for semantic retrieval
                  github_token: ${{ secrets.GITHUB_TOKEN }}
                  targets: 'readme,docs' # Documentation targets to generate (comma-separated). Options: readme, docs
                  docs_output: 'docs' # Optional: Directory for the output documentation - Default: docs

1. Install

   npm install -g @sintesi/sintesi

2. Generate Documentation Don't have documentation? Let Sintesi inspect your code and create a living documentation site.

   sintesi documentation

   Or just a README:

   sintesi readme

3. Verify Integrity Run this in your CI/CD pipeline. If the code changes but the documentation doesn't, this returns exit code 1.

   sintesi check

4. Force Overwrite If you need to regenerate documentation or README files and want to bypass existing content checks, you can use the --force flag:

   sintesi documentation --force
   sintesi readme --force

   This will ignore existing files and regenerate them from scratch.

5. Output Options Output customization (for example, setting the directory where generated docs are written) is supported by specific commands and by the GitHub Action inputs (see docs_output in the workflow example above). Command-line flags and their names can change across releases; consult the official CLI reference for the authoritative, up-to-date list of options:

   👉 CLI Reference: https://sintesicli.dev/reference/commands.html

6. Manage Changesets Sintesi integrates with Changesets for versioning and releases. Use the changeset command to create or manage changeset metadata and prepare packages for release:

   sintesi changeset

   This command helps manage the Changesets used by the project for changelogs and package publishing.

🧠 How it Works

Sintesi is not just a generator; it is a full documentation lifecycle manager.

1. Analyze: It scans your project structure and reads key files to understand the "DNA" of your codebase.
2. Plan: An AI Architect designs a documentation structure tailored to your project type.
3. Generate: Specialized agents (Planner, Writer, Reviewer, and Researcher) write comprehensive documentation, ensuring accuracy by reading actual source code.
4. Verify: The check command ensures your documentation stays in sync with your latest code changes.

📚 Documentation

We believe in eating our own dog food. This repository's documentation is maintained by Sintesi.

👉 Concepts — Architecture
👉 Concepts — RAG
👉 CLI Reference

To contribute to the docs or the project, see the repository: https://github.com/doctypedev/sintesi

---

What is Multi-Agent AI?

Multi-Agent AI refers to the use of multiple specialized agents that work collaboratively to achieve a common goal. In the context of Sintesi, these agents (Planner, Writer, Reviewer, and Researcher) each have distinct roles that enhance the quality and accuracy of the documentation process. This approach allows for a more nuanced understanding of the codebase, resulting in documentation that is not only comprehensive but also contextually relevant.

---

Retrieval-Augmented Generation (RAG)

Sintesi includes a Retrieval-Augmented Generation (RAG) pipeline that enhances the documentation generation process. This feature allows for semantic context retrieval, improving the accuracy and relevance of generated documentation.

---

Contributing

We love contributions! Please check out our Contributing Guide:

• Repository-level CONTRIBUTING.md: CONTRIBUTING.md
• Docs-level guide: docs/CONTRIBUTING.md

If you'd like to contribute to the docs site itself, please open issues or PRs in the main repository: https://github.com/doctypedev/sintesi

---

License

MIT © Doctypedev/sintesi