From 7a99908d8ff962df04237e81ea26e31cad4718bb Mon Sep 17 00:00:00 2001
From: deanpretorius <52314971+deanpretorius@users.noreply.github.com>
Date: Fri, 13 Mar 2026 14:34:15 +0200
Subject: [PATCH 1/2] Updated README
Clarified the process for making edits via GitHub and added detailed steps for using the GitHub interface.
---
README.md | 26 +++++++++++++++++++++-----
1 file changed, 21 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index fe3a834d..298c31a5 100644
--- a/README.md
+++ b/README.md
@@ -10,17 +10,33 @@ There are some ways to edit this site:
2. Through the source code at local.
3. Through the online service like Stackblitz
-Since most users cannot directly commit to the repository, you will need to perform a pull request to perform edits. This process is quite easy when editing pages directly from the github web interface. Below is a description of how the process works in github.
+Since most users cannot directly commit to the repository, you will need to perform a pull request to perform edits.
+
+// Github pages does not allow direct editing of the pages.
+This process is quite easy when editing pages directly from the github web interface. Below is a description of how the process works in github.
If you wish to download and modify the source code, you will need to fork, modify and create a pull request. This process is discussed below.
## Github Interface
-You are welcome to perform basic edits using the htts://github.com web interface. Here is a quick summary:
+You are welcome to perform basic edits by following the steps outlined below:
+
+1. Navigate to the documentation home page: https://github.com/idempiere/idempiere.github.io
+
+2. Click the edit button shown in the image below:
+
+
+3. This button creates a fork of the repository linked to your personal github account, and opens the file you indicated you wish to edit.
+Add the edits you wish to make to the documentation, and click on the green "Commit changes..." button as shown in the image below:
+
+
+4. Copilot will generate a commit message for your edits. Click "Proceed" to accept the edits, and commit them to your forked repository:
+
+
+5. Github will display all the changes you have committed. Confirm the changes you are proposing, and click "Create Pull Request".
+Provide a name for the pull request, and write down a summary of the pull request and click "Create Pull Request".
+
-- Navigate to any given page (example: https://idempiere.github.io/docs/introduction)
-- Click on the 'edit this page' link at the bottom of the page.
-- Since most users cannot directly commit to the repository, github will guide you through
## Source Code At Local
From 6713bbfc5be7312ca2845d2fba969a04900b03a0 Mon Sep 17 00:00:00 2001
From: deanpretorius <52314971+deanpretorius@users.noreply.github.com>
Date: Mon, 16 Mar 2026 08:48:53 +0200
Subject: [PATCH 2/2] Update README.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 298c31a5..2636f91b 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,8 @@ There are some ways to edit this site:
Since most users cannot directly commit to the repository, you will need to perform a pull request to perform edits.
-// Github pages does not allow direct editing of the pages.
-This process is quite easy when editing pages directly from the github web interface. Below is a description of how the process works in github.
+GitHub Pages does not allow direct editing from rendered site pages.
+This process is easy when editing from the GitHub web interface. Below is how it works in GitHub.
If you wish to download and modify the source code, you will need to fork, modify and create a pull request. This process is discussed below.