Docs
About the Portal
What this documentation portal is, why it exists, and how it works.
What Is This?
Ontopix Docs is the centralized documentation portal for all Ontopix teams. It aggregates documentation from multiple repositories into a single searchable site, giving everyone — engineers, designers, product managers, and AI agents — one place to find authoritative information.
Why a Centralized Portal?
Documentation tends to scatter across wikis, README files, Notion pages, and Slack threads. This portal solves that by:
- Pulling content directly from source repos — documentation lives next to the code it describes and stays in sync
- Providing a unified reading experience — consistent navigation, search, and styling across all domains
- Serving as an MCP source — AI agents can query documentation programmatically, making internal knowledge available during AI-assisted workflows
How It Works
The portal is built with Nuxt 4 and Nuxt Content. Each documentation domain is defined as a collection in content.config.ts:
- Bundled collections (
docs) — Markdown files in this repository'scontent/directory - Remote collections (
engineering,stylebook, etc.) — Markdown files pulled from external repositories at build time
When the site builds, Nuxt Content fetches all collections, generates navigation trees, and produces static pages. The result is deployed to AWS Amplify.
Architecture Overview
┌─────────────────────────────────────────────────┐
│ Ontopix Docs │
│ (Nuxt 4 + Nuxt Content) │
├─────────────┬─────────────┬─────────────────────┤
│ docs/ │ engineering/│ stylebook/ │ ... │
│ (bundled) │ (remote) │ (remote) │ │
├─────────────┴─────────────┴─────────────────────┤
│ MCP Server (/mcp) │ LLMs (/llms.txt) │
├─────────────────────────────────────────────────┤
│ AWS Amplify (hosting) │
└─────────────────────────────────────────────────┘
Key Components
| Component | Purpose |
|---|---|
content.config.ts | Defines collections and their GitHub sources |
nuxt.config.ts | Framework configuration, modules, LLMs/MCP settings |
app/composables/ | Smart navigation and routing logic across collections |
server/mcp/tools/ | MCP tools for AI agent access (list-pages, get-page) |
layers/ontopix-ui/ | Shared UI layer with Ontopix brand colors |
Tech Stack
| Technology | Role |
|---|---|
| Nuxt 4 | Application framework |
| Nuxt Content | Content management and GitHub integration |
| Nuxt UI | Component library |
| nuxt-llms | LLM-ready content generation (/llms.txt) |
| @nuxtjs/mcp-toolkit | MCP server for AI agent integration |
| AWS Amplify | Hosting and deployment |