Galileo Docs

This repo is the source for Galileo's docs. We use Mintlify for building and publishing our docs.

Contributing

See our contributing guide for more details.

Dev container

This repo has a devcontainer configured so you can run in VS Code with the dev containers extension and Docker, or in a code space, and have an isolated environment with all the relevant tools installed.

This container installs the Mintlify CLI as well as Vale for spellchecking. It also has some recommended extensions. If you find any other extensions useful, please add them to the devcontainer.json file.

Build and view the docs

We use Mintlify for building and publishing our docs.

To build and run the doc locally:

1. Install the Mintlify CLI:

   npm install -g mint

2. Run the Mintlify CLI:

   mint dev

Check for broken links

Before pushing a change, check for broken links using:

mint broken-links

Check spellings

This repo is set up to use Vale to check spellings. To use it, first install Vale:

brew install vale

Then install MDX2VAST:

npm install -g mdx2vast

Then you can check spelling using:

vale . --glob='!{sdk-api/**/reference/**/*.*}'

This command ignores the generated SDK code.