- This is a documentation site built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Run
mint devto preview locally - Run
mint broken-linksto check links
tracebloc's canonical vocabulary is defined in TERMINOLOGY.md
— the single source of truth for the words we use (one concept, one word).
Follow it for all docs copy. If a term you need isn't there, add it to
TERMINOLOGY.md first, then use it. Do not redefine terms here.
{/* Add any project-specific style rules below */}
- Use active voice and second person ("you")
- Keep sentences concise — one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click Settings
- Code formatting for file names, commands, paths, and code references
{/* Define what should and shouldn't be documented /} {/ Example: Don't document internal admin features */}