Skip to main content

​
Two Documentation Layers

This repo intentionally uses two docs layers:
  • docs/public for the Mintlify docs site
  • docs/architecture for internal notes and maintainers documentation

​
What Belongs In Public Docs

Use docs/public for:
  • setup guides
  • provider docs
  • product feature docs
  • customer-safe architecture explanations
  • launch and troubleshooting guides

​
What Belongs In Internal Docs

Use docs/architecture for:
  • implementation notes
  • refactor plans
  • internal tradeoffs
  • maintainer-only concerns
  • details you would not want exposed publicly

​
How Navigation Works

The Mintlify site structure is controlled in:
  • docs/public/mint.json
If you add a page but forget to add it there, the page may exist without being discoverable in the docs UI.

​
Good Writing Standard

Public docs in this repo should usually:
  • assume the reader is not deeply technical
  • explain what a feature is before listing env vars
  • describe why something matters, not only how to toggle it
  • stay accurate to the current codebase
That is especially important for AnotherWrapper because many buyers want to understand the product before they understand the implementation.