Skip to content

Commit

Permalink
Refactor contribution documentation and update images
Browse files Browse the repository at this point in the history
  • Loading branch information
IhsenBouallegue committed Oct 20, 2024
1 parent 0a57a33 commit 6ec5253
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
Binary file added src/assets/images/edit-a-page-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/edit-a-page-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/edit-a-page-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions src/content/docs/development/contribution-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ description: A guide to help anyone contribute to OpenIPC's docs.

# Contributing to the OpenIPC Documentation

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.
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.

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.

---

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

For more details, check the [official documentation](https://docs.openipc.org).

This is an image [Example Image](/src/assets/images/example-image.png)
```
:::caution
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](/src/assets/images/example-image.png)`

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

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

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

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

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

For example:

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

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

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

### 4. Create a Pull Request (If Necessary)
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.
Expand Down

0 comments on commit 6ec5253

Please sign in to comment.