Vantage Docs

Vantage Docs is the official documentation site for Vantage Compute, built with Docusaurus 3.

Table of Contents

• Getting Started
• Local Development
• Building the Site
• Project Structure
• Deployment
• Contributing
• License

Getting Started

Prerequisites

• Node.js >= 22
• Yarn (via Yarn Berry, config in .yarnrc.yml)
• just (optional, wraps the common commands)

Installation

yarn install

This installs all dependencies required to build and run the documentation site.

Local Development

Start a local development server with live reload:

yarn start

Or, using just (which also fetches the latest CLI docs from the v8x repo first):

just dev

Most changes are reflected live without needing to restart the server.

Building the Site

Generate the static production bundle:

yarn build

The static files are output to the build/ directory. Serve them locally with:

yarn serve

Project Structure

├── docs/                 # Documentation content (Markdown/MDX)
├── src/                  # Custom React components, theme, CSS, context
├── static/               # Static assets served as-is (images, fonts, js)
├── scripts/              # Build-time helpers (e.g. fetch v8x CLI docs)
├── docusaurus.config.js  # Docusaurus site configuration
├── sidebars-main.js      # Sidebar structure (Diataxis)
├── justfile              # Common task recipes
└── package.json          # Project metadata and scripts

Deployment

Deployment is automated via the GitHub Actions workflow in .github/workflows/deploy.yml. On push to main, the site is built and published to GitHub Pages. No local CDK deployment is required.

Contributing

We welcome contributions! To contribute:

1. Fork the repository and create a new branch for your feature or fix.
2. Make your changes, following the existing code style and structure.
3. Update or add documentation as needed.
4. Submit a pull request with a clear description of your changes.

For spelling and terminology, see .cspell.yaml and .cspell/vantage-dictionary.txt.

License

© Vantage Compute - All Rights Reserved.