mirror of
https://github.com/holos-run/holos.git
synced 2026-03-20 09:15:02 +00:00
ee30c52673
Without this patch each version of the core and author schemas are duplicated into each docs version. This is unnecessary and difficult to maintain now that we have docusaurus versioned docs enabled. This patch updates the schema generation script to check if the docs version has been released, and if so write into a markdown file in the versioned docs folder. If not, the version is written into the next version folder. This patch also updates some, but not all, document links to the md or mdx relative file paths. This is necessary to generate the correct versioned links. A nice outcome of this change is that technical docs no longer need to link to version specific pages. For example, `[Core Schema]: ./api/core.md` will always refer to the correct auto generated docs associated with the docs version.
Website
This website is built using Docusaurus, a modern static website generator.
Installation
npm install
Local Development
npm run 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
npm run build
This command generates static content into the build directory and can be
served using any static contents hosting service.
Deployment
Deployments are made with Cloudflare Pages. Cloudflare deploys on changes to the main branch, and Pull Requests get comments with links to preview environments.