Voltimax Platform

Appearance

Documentation Overview ​

This guide explains how to work with the Voltimax Platform documentation system. Whether you're writing user guides, integration docs, or developer documentation, you'll find everything you need here.

Quick Navigation ​

Choose the guide that matches your task:

  • Structure - Understand how documentation is organized
  • Writing - Learn writing guidelines and best practices
  • Templates - Use templates for consistent documentation
  • Generation - Work with auto-generated reference docs
  • VitePress - Configure and build the documentation site
  • Workflows - Follow common documentation workflows
  • Reviewing - Review checklists and maintenance

Getting Started ​

I want to ​

Write a new user guide ​

  1. Choose a template (likely How-To or Quickstart)
  2. Follow writing guidelines for user-facing content
  3. Use the workflow for adding pages

Document an API or protocol ​

  1. Check if it's auto-generated
  2. If hand-written, use the API Getting Started template
  3. Follow integration writing guidelines

Update auto-generated docs ​

  1. Update the schema source files
  2. Follow the generation workflow
  3. Review and commit both schema and docs

Add a new documentation section ​

  1. Understand the structure
  2. Configure VitePress sidebars
  3. Use appropriate templates

Documentation Philosophy ​

Our documentation follows these principles:

  • Structure over freedom - Use templates for consistency
  • Audience-first - Write for operators, integrators, or developers
  • Code-adjacent - Update docs when you update features
  • Auto-generate when possible - Reference docs come from schemas
  • Intent over surface - Document why and trade-offs, not what the code already says
  • Single source of truth - Write a fact once and cross-link; duplicated content drifts
  • Prefer linking to code - Avoid inline code examples that go stale; link to real source files instead

Quick Reference ​

Documentation Sections ​

SectionAudienceTypePath
GuideOperatorsHand-written/docs/guide/
IntegrationsIntegratorsHand-written/docs/integrations/
DeveloperContributorsHand-written/docs/developer/
ReferenceAllAuto-generated/docs/reference/

Common Commands ​

bash
# Start local dev server
cd docs && npm run docs:dev

# Build production site
cd docs && npm run docs:build

# Regenerate all reference docs
.\cli.ps1 generate --ocpp-by-category --sunspec-by-category

Resources ​