Massdriver Docs

Enabling Pre-commit

This repo includes pre-commit hooks, use 'em!

Install precommmit on your system.

git init
pre-commit install

Local development

The docs are generated using Docusaurus:

yarn start
open http://localhost:3000/

Or with docker

docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:19-alpine3.16 yarn
docker run --rm -it -v $PWD:/app -w /app -p 3001:3000 node:19-alpine3.16 yarn start

Generating GQL Docs

To update the GraphQL docs, you'll need access to generated the GraphQL SDL file from Massdriver.

cd $MASSDRIVER_DIR
mix absinthe.schema.sdl
mv schema.graphql $DOCS_DIR/schema/md.graphql
cd $DOCS_DIR
npx docusaurus graphql-to-doc

Sync CLI docs

The Massdriver CLI has markdown docs for all commands. They can be sync'd to ./cli w/ the following command:

make sync-cli-docs

---