Docs Official

🚀 Galileo Docs

This repository serves as the source for Galileo's documentation. We utilize Mintlify for building and publishing our docs.

🚀 Quick Start

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

✨ Features

• Isolated Development Environment: The repo has a devcontainer configured. You can run it in VS Code with the dev containers extension and Docker, or in a code space, getting an isolated environment with all relevant tools installed.
• Spell - checking and Link Verification: It uses Vale for spell - checking and provides a way to check for broken links.

📦 Installation

Install Mintlify CLI

To build and run the doc locally, you need to install the Mintlify CLI:

npm install -g mint

Install Vale

This repo uses Vale to check spellings. First, install Vale:

brew install vale

Install MDX2VAST

npm install -g mdx2vast

💻 Usage Examples

Build and View the Docs Locally

1. After installing the Mintlify CLI, run the Mintlify CLI:

mint dev

Check for Broken Links

Before pushing a change, check for broken links using:

mint broken-links

Check Spellings

You can check spelling using:

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

This command ignores the generated SDK code.

📚 Documentation

Contributing

See our contributing guide for more details.

Dev Container

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