Ampersand docs

This repo contains the source files for https://docs.withampersand.com, which includes:

• Guides: their source files are .mdx files in the src folder
• Reference docs: which are generated from the OpenAPI spec files in the amp-labs/openapi repo when pnpm run gen is run.

Release process

Merges to the main branch will automatically update the online docs via the Mintlify Github app.

First time setup

Ensure you have pnpm installed globally

npm install -g pnpm

Install dependencies

pnpm i

Adding a new page

If you need to add a new page, add it to the mintConfig object in src/generate-mint.ts, and then follow the steps below for regenerating mint.json.

Changing the URL of a page

If you are changing the URL of a page, be sure to add the old URL to the redirects section of the mintConfig object in src/generate-mint.ts, and then follow the steps below for regenerating mint.json.

Generate mint.json & API references

src/mint.json is the main configuration file for the docs. Do not edit it manually, edit src/generate-mint.ts instead.

The gen command will do 2 things:

• re-generate src/mint.json based on src/generate-mint.ts
• re-generate API reference docs based on amp-labs/openapi

pnpm run gen

Preview docs locally

pnpm run dev 

The local preview is available at http://localhost:3000, and will hot-load any changes to .mdx files.

Style guide

Please see CONTRIBUTING.md.