This is our user-facing documentation site, powered by mintlify. Be sure to check out Mintlify's documentation.
Working on a documentation site invites using very long-lived feature branches, which will result in bad merges conflicts.
We'll be avoiding that by practicing trunk based development with dark releases - we'll all be working on the main branch, constantly pushing our changes to avoid merge conflicts, but we will also be hiding our uncompleted work. Essentially, we'll be decoupling deployment from release.
Read more at Dark release below.
To run this site locally, make sure you have the Mintlify CLI installed. Run the following command:
npm i -g mintlifyAnd then:
npm run devThe site should run on http://localhost:3000.
To add a new page, create a new .mdx file with a title and a description. The project's folder structure represents the site's URL structure.
Creating an .mdx file also creates a page in the website, but doesn't add it to the navigation bar. This means that you can access your page directly by typing in its URL explicitly. The URL will be determined by the project's folder structure. For example, the file ./basic/create-repo.mdx will be under [base url]/basic/create-repo.
This will allow us to do two things:
- Easily share the documentation with each other to get feedback before making it public.
- Avoid merge conflicts, especially in the
mint.jsonfile which configures not only the navigation, but the entire site.
Once you're happy with your new page, add it to the mint.json file under navigation. This will tell mintlify to add the page to the navigation sidebar.
Then, just push your changes. The website updates automatically after pushing.