Junction Docs

• Ensure you have Node.js 18 installed, then run corepack enable and pnpm install.
• Run pnpm start from the repository root to start the local Mintlify development server.
• To pull the latest changes from the openapi spec in production, run wget https://api.tryvital.io/openapi.json -O ./docs/swagger.json, or for the openapi spec in sandbox wget https://api.sandbox.tryvital.io/openapi.json -O ./docs/swagger.json.

The openapi spec in this repository is automatically synchronized with Junction's primary codebase, meaning a merge to main in the primary codebase triggers an update to the openapi spec in this repository, and a consequent deployment. The only exception to this rule is if a new endpoint is created.

PRs are checked by Vale for style violations (e.g. capitalised API entities, British spellings). If your PR fails the Vale check, run it locally to see the errors before pushing:

brew install vale        # one-time setup
vale docs/               # lint everything
vale docs/path/to/file.mdx  # lint a specific file

To suppress a false positive on a specific line:

<!-- vale Junction.EntityCase off -->
The Team API Key header...
<!-- vale Junction.EntityCase on -->

Install the Vale VS Code extension to see violations inline as you write.

For more information about mintlify see docs If you have any issues running the docs locally you may find answers here