diff --git a/edit.mdx b/edit.mdx index 3d30620f7..c2ae9d538 100644 --- a/edit.mdx +++ b/edit.mdx @@ -26,6 +26,6 @@ Get inspiration from other Mintlify users on our There are two ways to edit your repo online. -- Find the edit button on the file you'd like to edit. This will open an in-line web editor in Github. +- Find the edit button on the file you'd like to edit. This will open an in-line web editor in GitHub. ![](/images/edit-online.png) -- Open your git repo in Github's [github.dev](https://github.dev) online IDE. Take the URL of your repo and replace `github.com` with `github.dev`. (e.g. `github.dev/mintlify/docs` instead of `github.com/mintlify/docs`) +- Open your git repo in GitHub's [github.dev](https://github.dev) online IDE. Take the URL of your repo and replace `github.com` with `github.dev`. (e.g. `github.dev/mintlify/docs` instead of `github.com/mintlify/docs`) diff --git a/quickstart.mdx b/quickstart.mdx index 7c21eb324..6e732b79a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -11,14 +11,14 @@ Welcome to the Mintlify documentation guide. Follow the instructions below to le ### 1. Deploying Your Docs Repository -Mintlify docs are rendered from MDX files and configurations defined in our [starter template](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 template](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. @@ -26,9 +26,9 @@ Mintlify docs are rendered from MDX files and configurations defined in our [sta - + - 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 on your [dashboard](https://dashboard.mintlify.com). 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 on your [dashboard](https://dashboard.mintlify.com). 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) @@ -59,9 +59,9 @@ Mintlify enables you to easily customize the style, structure, and content of yo 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`. @@ -106,7 +106,7 @@ Mintlify enables you to easily customize the style, structure, and content of yo - 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/add-members.mdx b/settings/add-members.mdx index be5199dfa..d39d099a4 100644 --- a/settings/add-members.mdx +++ b/settings/add-members.mdx @@ -3,7 +3,7 @@ title: 'Editor Permissions' description: 'Allow more members of your team to update your docs' --- -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.