diff --git a/quickstart.mdx b/quickstart.mdx index 58d3f6ea7..c9a08de49 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -22,28 +22,26 @@ supercharge your documentation with Mintlify. ### 1. Deploying Your Docs 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 -your docs with your code, and make source control effortless. +Mintlify docs are rendered from MDX files and configurations defined in our [starter kit](https://git.new/docs). 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: - 1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later. + To create your docs repo without logging into GitHub, follow these instructions: + 1. Clone our [starter template](https://git.new/docs) 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) @@ -73,9 +71,9 @@ your docs. 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. + * 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`. + * 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`. @@ -130,7 +128,7 @@ your docs. - 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) diff --git a/settings/global.mdx b/settings/global.mdx index eb2eb3a6d..b8220e765 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -116,10 +116,10 @@ settings. Learn more about the [properties](#properties) or from an ``` - + The font family name. Custom fonts and all [Google - Fonts](https://fonts.google.com/) are supported. e.g. "Open Sans", - "Playfair Display" +  Fonts](https://fonts.google.com/) are supported. e.g. "Open Sans", + "Playfair Display." The font weight. Precise values such as `560` are also supported for @@ -233,11 +233,11 @@ settings. Learn more about the [properties](#properties) or from an - The [Fontawesome](https://fontawesome.com/icons) icon for the group. Note: this only applies to sub-folders. + The [Font Awesome](https://fontawesome.com/icons) icon for the group. Note: this only applies to sub-folders. - The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin + The type of [Font Awesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin @@ -371,20 +371,20 @@ An object to configure the footer with socials and links. Example: ```json "footer": { - "socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" }, + "socials": { "x": "https://x.com/mintlify", "linkedin": "https://linkedin.com/company/mintlify" }, "links": [ { "title": "Column 1", "links": [ - { "label": "Column 1 Link 1", "url": "https://mintlify.com" }, - { "label": "Column 1 Link 2", "url": "https://mintlify.com" } + { "label": "Column 1 Link 1", "url": "https://mintlify.com/customers" }, + { "label": "Column 1 Link 2", "url": "https://mintlify.com/love" } ] }, { "title": "Column 2", "links": [ - { "label": "Column 2 Link 1", "url": "https://mintlify.com" }, - { "label": "Column 2 Link 2", "url": "https://mintlify.com" } + { "label": "Column 2 Link 1", "url": "https://mintlify.com/community" }, + { "label": "Column 2 Link 2", "url": "https://mintlify.com/careers" } ] } ]