Documentation map

Find the next useful answer.

This guide explains the product model. The project documentation below is the canonical, exhaustive reference for authoring, profiles, themes, commands and development.

Command palette

Ask the compiler, not a stale template.

These commands form the everyday interface. Run the one that answers the question you actually have.

I need to…RunWhat it gives me
See available document typesdocc typesKnown types with their descriptions and themes.
Know a type’s requirementsdocc describe ch_letterThe full contract: frontmatter, body, semantic syntax, blanks and rules.
Start a valid source filedocc example ch_letter > brief.mdA compact example owned and tested by the schema.
Find every problem before outputdocc check brief.mdAll collected diagnostics with positions and hints.
Produce the Word documentdocc build brief.mdValidation first, then a .docx beside the source.
Understand parsed content as datadocc read brief.mdFrontmatter, body, spans and fields in JSON.
See configuration in effectdocc doctorThe resolved schemas, themes and profile source.
Get editor diagnosticsdocc lspThe language server over standard input and output.
Use a managed profiledocc profile use REPOSITORYAn installed, pinned profile bound to the project.
For tools and CI: use --json on supported commands. Successful command results stay structured on stdout; build validation diagnostics remain a separate JSON object on stderr.
The daily loop

One source, one feedback loop.

Discover. Start with types, describe and example. They make the document contract visible before you draft.

Author. Edit Markdown and frontmatter. Keep facts as data and prose as prose.

Check. Run docc check during drafting or let the LSP surface the same diagnostics in the editor.

Build. Render only the passing source. The profile supplies the fixed look; the compiler supplies the proof that the declared requirements passed.

Review inputs. Treat a changed source, schema, theme or profile lockfile as a real document change. Rebuilds are deterministic.

# A minimal, explicit CI check.
docc check --strict docs/*.md

# A machine-readable variant for another tool.
docc check --json docs/*.md
Canonical project docs

Go deeper by the question you have.

A useful diagnostic path

When a document does not build, start with the source line.

Read the error code, caret and hint. Correct the authored file first. If the reported issue is about a type requirement, inspect docc describe <type>. If it is about what profile or theme is active, use docc doctor or docc profile status.

docc check brief.md
# Correct source facts or structure from the diagnostics.

docc describe ch_letter
# Revisit the type contract.

docc doctor
# Verify the schema and theme selection.
Do not repair the generated Word file as the primary source. The Markdown file is the input the compiler can verify and rebuild. A manual output patch cannot become part of that contract.