Skip to content

Commit 11dc04d

Browse files
committed
docs: update image paths, apply copilot suggestions
1 parent f20d402 commit 11dc04d

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/en/contributing/contributing-to-docs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing to documentation
22

33
You would like to contribute to the documentation site? Great!
4-
We use [MkDocs](https://www.mkdocs.org/) and [Github pages](https://pages.github.com/) for the documentation site you're reading right now.
4+
We use [MkDocs](https://www.mkdocs.org/) and [GitHub pages](https://pages.github.com/) for the documentation site you're reading right now.
55

66
Here is a step-by-step guide on how to create/edit pages.
77

@@ -45,7 +45,7 @@ If Python is not installed, you can download it from the [official Python downlo
4545
!!! note "For Windows users"
4646
During installation, make sure to check the box that says "Add Python to PATH" if the installer offers such an option (it's usually off by default).
4747

48-
![Add Python to PATH](./img/python-windows-path.png)
48+
![Add Python to PATH](img/python-windows-path.png)
4949

5050
### Text Editor (Optional)
5151

@@ -73,15 +73,15 @@ We recommend [Visual Studio Code (VS Code)](https://code.visualstudio.com/), a f
7373
Now head over to the [pylon-docs repository](https://github.com/pylonmc/pylon-docs).
7474
Click the "Fork" button in the top-right corner of the page to create your own copy of the repository.
7575

76-
![GitHub Fork](./img/github-fork.png)
76+
![GitHub Fork](img/github-fork.png)
7777

7878
## Step 2: Cloning your fork
7979

8080
You will need to clone your forked repository to your local machine to be able to preview the changes.
8181

8282
First, go to your forked repository on GitHub, click on the green "Code" button, and copy the URL under "HTTPS".
8383

84-
![GitHub Clone URL](./img/github-clone.png)
84+
![GitHub Clone URL](img/github-clone.png)
8585

8686
Open your terminal and run the following command (replace `<CLONE_URL_HERE>` with the URL you just copied):
8787

@@ -188,17 +188,17 @@ If the `img/` folder doesn't exist in that directory, create it first.
188188
To embed an image in your markdown file, use the following syntax:
189189

190190
```markdown
191-
![Image description](./img/your-image-name.png)
191+
![Image description](img/your-image-name.png)
192192
```
193193

194194
- Replace `Image description` with a short description of what the image shows
195195
- Replace `your-image-name.png` with your actual filename
196-
- The `./img/` path is relative to your current markdown file
196+
- The `img/` path is relative to your current markdown file
197197

198198
**Example:**
199199

200200
```markdown
201-
![GitHub Fork button](./img/github-fork.png)
201+
![GitHub Fork button](img/github-fork.png)
202202
```
203203

204204
## Step 5: Previewing your changes
@@ -236,9 +236,9 @@ Once you pushed your changes to your fork on GitHub, you can create a pull reque
236236

237237
1. Go to your forked repository on GitHub. You can always find your fork on GitHub's dashboard or your profile page.
238238
2. Click on the "Pull requests" tab.
239-
![GitHub Pull Requests Tab](./img/github-pull-requests.png)
239+
![GitHub Pull Requests Tab](img/github-pull-requests.png)
240240
3. Click on the green "New pull request" button.
241-
4. Fill the title and description for your pull request.
241+
4. Fill in the title and description for your pull request.
242242
5. Click "Create pull request".
243243

244244
That's it! Your changes will be reviewed by the maintainers. If everything looks good, your contribution will be merged. 🎉

0 commit comments

Comments
 (0)