Skip to main content

Docusaurus Documentation Architecture

This page describes how the documentation site at docs.infowebplus.com is built and deployed.

For a high-level system view including the main app, see:

Project structure​

The Docusaurus project in this repository follows the standard layout:

docs.infowebplus.com/
├── docs/                 # Markdown and MDX content
├── src/                  # React components and CSS
├── static/               # Static assets (images, etc.)
├── docusaurus.config.ts  # Docusaurus configuration
├── sidebars.ts           # Sidebar/navigation structure
└── package.json          # Dependencies and scripts

See the root README.md in this repo for local development and deployment commands.

Routing and base URL​

Docs are served at the root path:

  • url: https://docs.infowebplus.com
  • baseUrl: /
  • routeBasePath: / (docs plugin)

That means:

  • / → landing page (docs/intro.md)
  • /getting-started/installation → installation guide
  • /architecture/overview → architecture overview

Navigation is controlled by:

  • docusaurus.config.ts – navbar, footer, theme
  • sidebars.ts – sidebar categories and doc ordering

Deployment​

The documentation is deployed to Cloudflare Pages:

  • Automated builds on pushes to the main branch
  • Build command (in Cloudflare Pages):
cd docs && npm install && npm run build

More detailed deployment information:

Versioning​

Docusaurus supports versioned documentation. At the moment:

  • This project is configured for a single “current” documentation version.
  • No versioned_docs directory has been created yet.

To introduce versioned docs safely:

  1. Decide your first version label (for example, 1.0.0).

  2. Run (from the docs root):

    npx docusaurus docs:version 1.0.0

  3. Commit the generated versioned_docs, versioned_sidebars, and versions.json.

For workflow details, see the Docs Versioning Guide.

TODO

Coordinate with the main Infowebplus application release process before enabling versioned docs in production so that the default docs always match the currently deployed app.