CapRover Website

Source for caprover.com, containing two independently built applications:

• marketing-site/: Next.js marketing site
• docs-site/: Docusaurus 3 documentation site
• content/: English source content and translations, grouped by locale
• scripts/: composition and production smoke checks

The production build uses Docusaurus as the base, then overlays the marketing site's index.html, _next/, and homepage-assets/ output.

Marketing site development

Requires Node.js 22.13 or newer.

cd marketing-site
npm ci
npm run dev

Run checks:

npm run lint
npm run format:check
npm test

Documentation development

The documentation site requires Node.js 20 or newer. Use Node.js 22 to match the production workflow.

cd docs-site
npm ci
npm start

Add English Markdown files in content/en/docs/ and register them in docs-site/sidebars.js. Docusaurus reads English directly from content/. The documentation commands validate every locale and generate translated Docusaurus build inputs before starting or building.

Documentation translations

Docusaurus internationalization is configured by content/locales.json. English is the source language. English documentation is served from /docs/*, and translated documentation uses the locale prefix, such as /es-ES/docs/*. Compatibility pages preserve the former /docs/<locale>/*.html URLs.

Each locale is complete and self-contained under content/<locale>/:

• docs/ contains documentation Markdown.
• marketing.json contains the flat Next.js marketing-site message catalog.
• docs-ui.json contains Docusaurus navigation, sidebar, document-title, and interface strings.
• Add a locale to content/locales.json after all three surfaces are complete.

Spanish is enabled in content/locales.json. Its documentation is published at /es-ES/docs/*, and the Docusaurus language menu switches between English and Spanish versions of the current document.

On an unprefixed page view, the combined static site uses a saved language-menu choice or selects a supported locale from the browser's preferences. The URL always identifies the language of the page being viewed.

Translation guidelines

Follow the repository-wide authoring and translation rules in content/README.md.

Build the combined site

From the repository root:

(cd docs-site && npm ci && npm run clean-build)
(cd marketing-site && npm ci && npm run lint && npm run format:check && npm test)
node scripts/compose-site.mjs
node scripts/smoke-combined-site.mjs

The deployable artifact is written to build/combined-site/.

Deployment

Pushes to master run .github/workflows/website-publish.yml, build both applications, compose and smoke-test the artifact, then publish it to GitHub Pages. Do not publish either framework's output directly.