Skip to content

README.md

Latest commit

 

History

History
56 lines (37 loc) · 1.67 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.67 KB

VeeCode Platform Documentation

This website is built using Docusaurus 3, a modern static website generator.

Sites

Branch Site Purpose
develop https://docs-next.platform.vee.codes/ Staging
main https://docs.platform.vee.codes/ Production

Development Workflow

  1. Create a feature branch off develop.
  2. Open a PR targeting develop — merging triggers an automatic deploy to the staging site.
  3. Review the changes on the staging site.
  4. Merge develop into main — triggers the production deploy.

The staging deploy works by force-pushing the develop branch to the main branch of the docs-next mirror repo, which has its own GitHub Pages deploy. See ADR-001 for details.

Installation

corepack enable
yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Upgrading

Check docusaurus version (the command will also output the current upgrade command):

./node_modules/.bin/docusaurus -V

Upgrade docusaurus version:

yarn up @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest @docusaurus/types@latest