From d9d65412addddaa906a33d03dbb077be522f9059 Mon Sep 17 00:00:00 2001 From: Tommerty <86270372+tommerty@users.noreply.github.com> Date: Wed, 6 Dec 2023 15:01:18 +0000 Subject: [PATCH] Update contribute-to-the-docs.mdx --- .../docs/contributing/contribute-to-the-docs.mdx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/content/docs/contributing/contribute-to-the-docs.mdx b/src/content/docs/contributing/contribute-to-the-docs.mdx index 0747855..e153a44 100644 --- a/src/content/docs/contributing/contribute-to-the-docs.mdx +++ b/src/content/docs/contributing/contribute-to-the-docs.mdx @@ -33,17 +33,18 @@ First off, thanks for considering contributing to the docs! We're always looking This is only required if you wish to build and preview the site locally. If you're not interested in doing this and just want to write pure markdown, you can skip this section. ::: Download the following software: -- [Node.js](https://nodejs.org/en/) -- [Git](https://git-scm.com/downloads) -- [PNPM](https://pnpm.io/installation) +- [Node.js](https://nodejs.org/en/) - Needed to run the scripts. +- [Git](https://git-scm.com/downloads) - Needed to clone the repository. +- [PNPM](https://pnpm.io/installation) - Needed to install the dependencies. - [GitHub Desktop](https://desktop.github.com/) (optional) - [Visual Studio Code](https://code.visualstudio.com/) (you can use any code editor you like, but this is what we use.) + NOTE: You may need to restart your computer after installing these tools. ## Getting started 1. Head over to GitHub and `fork` the [docs repository](https://github.com/doras-to/docs). There's a button to do this in the top right of the repository. This will create a copy of the docs repository in your own GitHub account. You can call it whatever you want! -2. Once you've done that, you can clone your forked repository to your computer. The easiest way to do this would be using [GitHub Desktop](https://desktop.github.com/), but you can also use the command line if you prefer. -3. Open the repo in your code editor of choice. We use [Visual Studio Code](https://code.visualstudio.com/), but you can use any code editor you like. +2. Once you've created the fork head over to your forked repo (https://github.com/YOURUSERNAME/docs most likely), and you can clone your forked repository to your computer. The easiest way to do this would be using [GitHub Desktop](https://desktop.github.com/), but you can also use the command line if you prefer. +3. Once you've cloned it, open the repo in your code editor of choice. We use [Visual Studio Code](https://code.visualstudio.com/), but you can use any code editor you like. 4. Open a terminal in your code editor and run the following commands: ```bash pnpm install