diff --git a/advanced/rest-api/trigger-update.mdx b/advanced/rest-api/trigger-update.mdx index 26b0968f3..b9fadca70 100644 --- a/advanced/rest-api/trigger-update.mdx +++ b/advanced/rest-api/trigger-update.mdx @@ -1,3 +1,4 @@ --- openapi: "POST /project/update/{projectId}" +hideApiMarker: true --- diff --git a/advanced/rest-api/update-status.mdx b/advanced/rest-api/update-status.mdx index 9e2e93b66..c4e806f86 100644 --- a/advanced/rest-api/update-status.mdx +++ b/advanced/rest-api/update-status.mdx @@ -1,3 +1,4 @@ --- openapi: "GET /project/update-status/{statusId}" +hideApiMarker: true --- diff --git a/development.mdx b/development.mdx index e1b0b8c61..15581014c 100644 --- a/development.mdx +++ b/development.mdx @@ -1,7 +1,6 @@ --- -title: 'Development' +title: 'Local Development' description: 'Preview changes locally to update your docs' -icon: 'terminal' --- @@ -10,8 +9,6 @@ icon: 'terminal' -Follow these steps to install and run Mintlify on your operating system: - **Step 1**: Install Mintlify: diff --git a/integrations/sdks/stainless.mdx b/integrations/sdks/stainless.mdx index 5aea91b2d..8a21bfab4 100644 --- a/integrations/sdks/stainless.mdx +++ b/integrations/sdks/stainless.mdx @@ -46,7 +46,7 @@ jobs: commit_message: 'Auto-updates from Stainless' ``` -This assumes the following secrets have been [uploaded to your Github Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions): +This assumes the following secrets have been [uploaded to your GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions): - `secrets.STAINLESS_API_KEY`: Your Stainless API key. -- `secrets.API_TOKEN_GITHUB`: A Github [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with permissions to push to your docs repo. +- `secrets.API_TOKEN_GITHUB`: A GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) with permissions to push to your docs repo. diff --git a/mint.json b/mint.json index 28ca41ff6..0636b0312 100644 --- a/mint.json +++ b/mint.json @@ -9,7 +9,7 @@ "layout": "sidenav", "favicon": "/favicon.svg", "sidebar": { - "items": "container" + "items": "border" }, "colors": { "primary": "#0D9373", @@ -60,10 +60,16 @@ "group": "Getting Started", "pages": [ "quickstart", - "development", + { + "group": "Editing", + "icon": "pen-paintbrush", + "pages": [ + "development", + "web-editor" + ] + }, "settings/global", "settings/navigation", - "web-editor", "migration" ] }, @@ -111,8 +117,7 @@ "settings/versioning", "settings/add-members", "settings/github", - "settings/gitlab", - "settings/authentication" + "settings/gitlab" ] }, { @@ -166,7 +171,9 @@ }, "advanced/user-auth/sending-data" ] - }] + }, + "settings/authentication" + ] }, { "group": "Analytics", diff --git a/quickstart.mdx b/quickstart.mdx index 5dd8c7d6a..fc6eb786c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -20,86 +20,63 @@ icon: "rocket" Welcome! Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify. -### 1. Deploying Your Docs Repository +### Creating the Repository Mintlify docs are rendered from MDX files and configurations defined in our -[starter kit](https://github.com/mintlify/starter). We use Github to integrate +[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate your docs with your code, and make source control effortless. - + If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify [dashboard](https://dashboard.mintlify.com). - To create your docs repo without logging into Github, follow these instructions: + To create your docs repo without logging into GitHub, follow these instructions: 1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later. 2. [Get in touch](mailto:support@mintlify.com) with our team to deploy your repo. + ![Starter Template](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/starter-template.png) + - + - The next step is to install our Github app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository. + The next step is to install our GitHub app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository. - ![Github Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) + + ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) + -### 2. Updating Your Docs +### Updating the Content Mintlify enables you to easily customize the style, structure, and content of your docs. - - We provide a white-glove migration service as part of our Enterprise plan. - Interested? Request it [here](mailto:sales@mintlify.com) - - - - - **Edit your project using the Mintlify Web Editor** - - See our [Web Editor documentation](/web-editor). - - We recommend still reading through our [brand customization section](#customizing-your-brand-mint-json) as well. - - - - - - **Edit Locally (Recommended for Developers):** + 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). 2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). 3. Use your favorite IDE to open the repository. - 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`. Learn more about this in our [development guide](/development). - - **Editing Online:** - - Here are two ways to edit your repository online: - - * To edit a single file, locate and click the edit button. This will open a web editor right on Github. - ![Edit Online](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/edit-online.png) - * For a more versatile online experience, open your git repository in Github's [github.dev](https://github.dev) online IDE. Simply replace `github.com` in your repo URL with `github.dev`. For example, use `github.dev/mintlify/docs` instead of `github.com/mintlify/docs`. + 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`. + + Learn more about this in our [local development guide](/development). + + - > **Monorepo Setup**
- > We also support a mono-rep setup, allowing you to add our starter template within a docs folder in your existing repo. - > 1. Clone the starter template and move its contents into your docs folder - > 2. Delete the .git directory. - > 3. You can also choose the path to your mint.json in the dashboard under 'Settings'
- > ![Monorepo](/images/monorepo.png)
- > The mono-repo setup eliminates the need for creating a new repo. + Learn more about how to use the web editor on our [guide](/web-editor). - + Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations: @@ -118,11 +95,11 @@ your docs. }, ``` - A full list of supported configurations can be found [here](/settings/global). + A full list of supported configurations can be found at [global settings](/settings/global). - + Add content with simple MDX files. Initiate your pages with this template: @@ -134,26 +111,21 @@ your docs. --- ``` - Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a wide array of components which are listed [here](/content/components). + Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components). - + - Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the Github app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com). + Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com). + ![Manual Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) + - -### 3. Supercharging Your Docs - -Mintlify supports an array of advanced features like API reference docs, -analytics, and versioning to accommodate any of your documentation needs. - - - + You can easily set up your API references using an OpenAPI document. @@ -175,22 +147,33 @@ analytics, and versioning to accommodate any of your documentation needs. - - - Integrate your docs into your website by hosting them on a custom domain. This is included even in the free Mintlify plan. Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. + - ![Custom Domain](/images/custom-domain.png) + Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics). + + We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). + + + + We provide a white-glove migration service as part of our Enterprise plan. + Interested? You can request it by [contacting us](mailto:sales@mintlify.com). + - +### Publishing - Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics). We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). + - - + Integrate your docs into your website by hosting them on a custom domain. This is included even in the free plan. + + Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain. + + + ![Custom Domain](/images/custom-domain.png) + -### All Done! + Congrats! You've set up your Mintlify Docs and it's looking amazing! Need support or want to give some feedback? You can join our diff --git a/settings/add-members.mdx b/settings/add-members.mdx index 0c0845705..3db06c950 100644 --- a/settings/add-members.mdx +++ b/settings/add-members.mdx @@ -4,7 +4,7 @@ description: 'Allow more members of your team to update your docs' icon: 'user-group-simple' --- -The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same Github account that was used while signing up for Mintlify. +The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify. If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check. diff --git a/settings/navigation.mdx b/settings/navigation.mdx index 6bcb15175..5ca9bfaeb 100644 --- a/settings/navigation.mdx +++ b/settings/navigation.mdx @@ -224,7 +224,7 @@ The `topbarCTA` field supports the following fields: `name`, `url`, and `type`. } ``` -#### Github +#### GitHub You can also configure the CTA button to link directly to your GitHub repository. Use the `topbarCtaButton` field with the `type` set to `github`. diff --git a/style.css b/style.css new file mode 100644 index 000000000..3d050677f --- /dev/null +++ b/style.css @@ -0,0 +1,6 @@ +@import url("https://use.typekit.net/zmy3zmk.css"); + +h1, h2, h3 { + font-family: "inter-variable", sans-serif; + font-variation-settings: "slnt" 0, "wght" 600; +} \ No newline at end of file diff --git a/web-editor.mdx b/web-editor.mdx index d3c4536f5..8f186b525 100644 --- a/web-editor.mdx +++ b/web-editor.mdx @@ -1,14 +1,11 @@ --- title: 'Web Editor' description: 'Edit your docs directly from the dashboard with live previews.' -icon: 'pen-to-square' --- Mintlify Web Editor is currently in beta. We are in the process of adding additional - features and fixing bugs. We'd love to get your feedback on what we can improve. - - Email us at [support@mintlify.com](mailto:support@mintlify.com) + features and fixing bugs. We'd love to get your feedback on what we can improve at [support@mintlify.com](mailto:support@mintlify.com). Web Editor is the preferred way to edit docs directly without having to open your IDE or run `mintlify dev`. @@ -148,31 +145,31 @@ As you type, you'll see more options pop up: Here are the types of content blocks available to add in the **"Visual Editor"**: - - - Paragraph - Headings - Bullet List - Numbered List - Table - Image - Blockquote + + + Paragraph + Headings + Bullet List + Numbered List + Table + Image + Blockquote - - - Callouts - Accordions - Accordion Group - Cards - Card Group - Code Block - Code Group - Tabs - Steps - Frames - Update + + + Callouts + Accordions + Accordion Group + Cards + Card Group + Code Block + Code Group + Tabs + Steps + Frames + Update