Monoline documentation
Find Monoline UI and Docs package guides, contributor documentation, architecture and release operations.
On this page
Use Monoline UI to build React interfaces, or Monoline Docs to build static Markdown/MDX documentation. This index connects consumer documentation with repository development and operations; each topic has one owning location.
Start using a package
| Goal | Start here | Continue with |
|---|---|---|
| Add UI components to a React app | UI package guide | Installation and component catalog |
| Create a documentation site | Docs package guide | Getting started and writing pages |
| Explore the Docs package in use | Run the demo | Authoring components |
| Generate Docs with an agent | Using with AI agents | Maintained Docs skill |
Both packages are available on npm. The repository demo is an ordinary Docs consumer, not an additional package API.
Consumer guides and reference
UI: Foundations, theming, composition patterns, accessibility and compatibility.
Docs: Configuration, frontmatter, CLI, programmatic API, OpenAPI generation, Markdown/AI exports, troubleshooting and support boundaries.
Contribute and understand the repository
- Contributor guide: prerequisites, local setup, focused verification, component changes and PR workflow for all four workspaces.
- Architecture: package boundaries, shared colors, build pipelines and verification layers.
- Root guidelines and Docs guidelines: engineering instructions for work in this repository.
- Docs fixtures: stable test consumers, separate from the public demo.
Deploy and maintain
- UI releases: package version intent, prepare/finalize workflows and publication recovery.
- Docs releases and recovery: npm publication, visual baselines, output promotion and remaining external acceptance checks.
- Docs deployment: root/subpath recipes for consumer sites and the repository demo.
- Docs migration: preserve URLs and configure host redirects when moving an existing site.
- Docs performance: benchmark commands, measured scope and regression budgets.
- Docs roadmap: remaining package priorities and release acceptance gates.
Where documentation lives
| Location | Owns |
|---|---|
Root README.md |
Product choice, brief examples and repository entry points |
| Package READMEs | Installation, public entry points and package requirements; these ship with their packages |
apps/website/app/docs/ |
UI consumer tutorials, component references and examples |
apps/docs-demo/content/ |
Docs consumer tutorials, configuration/reference pages and examples |
CONTRIBUTING.md |
Repository setup, contribution workflow and verification commands |
docs/ |
Documentation navigation, architecture and operational guides |
packages/docs/skills/ |
Authoritative Docs instructions for agents |
When public behavior changes, update its owning consumer guide and link to it from other entry points. Keep requirements tied to package manifests and commands tied to existing scripts. Test fixtures and generated visual baselines belong with tests; temporary reports and completed-work plans do not belong here.