Skip to content

Commit 6ec5253

Browse files
Refactor contribution documentation and update images
1 parent 0a57a33 commit 6ec5253

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

src/assets/images/edit-a-page-1.png

21.7 KB
Loading

src/assets/images/edit-a-page-2.png

44.8 KB
Loading

src/assets/images/edit-a-page-3.png

97.6 KB
Loading

src/content/docs/development/contribution-docs.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ description: A guide to help anyone contribute to OpenIPC's docs.
55

66
# Contributing to the OpenIPC Documentation
77

8-
Thank you for contributing to the OpenIPC documentation! This guide will walk you through two main ways to contribute: **adding a new page** and **editing an existing page**. There’s also a section for setting up a local development environment if you want to test the site locally.
8+
Thank you for contributing to the OpenIPC documentation! This guide will walk you through two main ways to contribute: **adding a new page** and **editing an existing page**. There’s also a section for setting up a local development environment if you want to test the site locally.
99

10-
For local development, we use a `.node-version` file to ensure the correct version of Node.js is used. If you want to test your changes locally, you will need to install Node.js, Yarn, and a Node version manager.
1110

1211
---
1312

@@ -88,7 +87,11 @@ This guide will walk you through the new feature introduced in the latest releas
8887
3. Enable the **New Feature** toggle.
8988

9089
For more details, check the [official documentation](https://docs.openipc.org).
90+
91+
This is an image [Example Image](/src/assets/images/example-image.png)
9192
```
93+
:::caution
94+
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](/src/assets/images/example-image.png)`
9295

9396
### 7. Add Your Page to the Sidebar Navigation (If Required)
9497

@@ -142,7 +145,7 @@ git push origin add-new-page
142145
- Go to the [OpenIPC documentation site](https://docs.openipc.org).
143146
- Find the page that you want to edit and click the **Edit page** button, as shown below:
144147

145-
![Edit Page Button](file-N2M9hUoQnicS6Iiuy7xPiO68)
148+
![Edit Page Button](/src/assets/images/edit-a-page-1.png)
146149

147150
This will take you directly to the corresponding markdown file in the GitHub repository.
148151

@@ -151,15 +154,15 @@ You’ll be taken to the GitHub editor, where you can make changes directly to t
151154

152155
For example:
153156

154-
![Editing the Page in GitHub](file-ma4rgPGbVYvpsTFMBI7zqjX0)
157+
![Editing the Page in GitHub](/src/assets/images/edit-a-page-2.png)
155158

156159
### 3. Propose Your Changes
157160
Once you've made your edits:
158161
- Scroll down to the **Propose changes** section.
159162
- Add a short commit message that describes the update.
160163
- Choose whether you want to commit directly to the main branch or create a new branch for the changes.
161164

162-
![Proposing Changes](file-5ntGecYmEj9Prak4NKMJUWtp)
165+
![Proposing Changes](/src/assets/images/edit-a-page-3.png)
163166

164167
### 4. Create a Pull Request (If Necessary)
165168
If you've created a new branch, click **Propose changes** to start a Pull Request (PR). In the PR description, explain what changes you made and why.

0 commit comments

Comments
 (0)