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

Documentation lives in Platformatic repo.

The scripts/doc-watcher.js file helps you "import" those docs into ./docs directory.

There are two ways to do this

• run ./scripts/doc-watcher.js --source ../relative/path/to/plt/docs/directory in one terminal and run npx docusaurus start on another
• run DOCS=path/to/platformatic/docs npm run start.

The script will keep directories in sync. You should work on platformatic/docs directory and commit changes in that repo. On this repo ./docs directory is git-ignored.

npm run start

On a unix system:

1. mkdir /workdir (chose your own directory)
2. cd /workdir
3. git clone https://github.com/platformatic/platformatic.git or use your own fork
4. git clone https://github.com/platformatic/oss.git or use your own fork
5. cd /workdir/oss
6. run DOCS=/workdir/platformatic/docs npm run start to start the development server

Deploy happens in Github Actions. Take a look at the workflow in .github folder.

We keep online only the last 5 versions of Platformatic backwards. Every time a new version is realeased, this repository is tagged with vX.Y.Z

To generate the documentation for a specific version, checkout the related tag and run the development server.

Sometimes when you delete a directory in ./docs, docusaurus will crash. Just stop it and restart.