Skip to main content

​
Purpose

Mintlify is the publishing and documentation layer of the Ignition Labs OS.
It provides a clear, consistent, and accessible way to share final, approved documentation across engineering, product, and company domains.
Where Obsidian supports private drafting, Mintlify is the authoritative system for published, version-controlled documentation.

​
When to use it

Use Mintlify when:
  • Documentation is ready for others to read.
  • You are writing or updating product specs, engineering guides, or company docs.
  • Information needs to be organized, searchable, and professional.
  • You want automatic documentation deployment on every commit.
Do not use Mintlify for:
  • Early drafts or exploratory thinking (use Obsidian).
  • Temporary notes or internal-only scratch work.
  • Unvalidated ideas or writing that will change rapidly.

​
How it fits into Ignition Labs

Mintlify represents the final stage of the documentation pipeline: Draft in Obsidian → Finalize in /docs → Mintlify renders → Linked in Linear + PRs Mintlify creates the shared source of truth for all teams and future contributors.

​
Setup

  1. Ensure docs.json is present inside /docs and properly structured.
  2. Go to the Mintlify dashboard and connect the GitHub repo.
  3. Choose the main branch as the source of published docs.
  4. Set the docs directory to docs and enable monorepo mode.
  5. Mintlify automatically rebuilds and redeploys when changes to /docs are pushed.

​
Best practices

  • Keep the tone calm, clear, and human.
  • Use headings and sections consistently for readability.
  • Avoid duplication; link to related documents instead.
  • Keep navigation organized using the structure in docs.json.
  • Commit documentation as part of feature PRs when relevant.
  • Validate all internal links before merging.

​
Anti-patterns

  • Do not publish raw or unedited Obsidian notes.
  • Avoid mixing multiple topics on one page.
  • Do not introduce breaking navigation changes without review.
  • Avoid oversized screenshots or assets unless necessary.

​
Examples

  • Updating /apps/rainy-day/ui-layout.md after finalizing UI drafts in Obsidian.
  • Adding /engineering-process.md updates alongside PR workflow changes.
  • Publishing new company principles or product philosophy sections in /company.
  • Obsidian Workflow
  • Root Documentation Overview: ../../README.md
  • Mintlify Navigation Configuration: ../../docs.json