Skip to content

Updated README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-ruiz merged 2 commits into from
Mar 16, 2026
Merged

Updated README #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a99908
Updated README
deanpretorius Mar 13, 2026
6713bbf
Update README.md
deanpretorius Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

## Github Interface
Comment thread
coderabbitai[bot] marked this conversation as resolved.

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:
<img width="1294" height="330" alt="image" src="https://github.com/user-attachments/assets/1e9e1907-bcdb-4f50-8fa8-b4a47dccde63" />

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:
<img width="1898" height="687" alt="image" src="https://github.com/user-attachments/assets/e3cd544a-b7ba-4b5e-b361-4ca846d51a38" />

4. Copilot will generate a commit message for your edits. Click "Proceed" to accept the edits, and commit them to your forked repository:
<img width="815" height="763" alt="image" src="https://github.com/user-attachments/assets/660740d4-2001-4489-9844-1f7f3b44fa61" />
Comment on lines +33 to +34

@coderabbitai coderabbitai Bot Mar 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Avoid making Copilot behavior sound mandatory.

On Line 33, “Copilot will generate a commit message” may not apply to all users/accounts. Suggest wording this as optional fallback so the instructions remain accurate for everyone.

Suggested edit 
-4. Copilot will generate a commit message for your edits. Click "Proceed" to accept the edits, and commit them to your forked repository:
+4. GitHub may suggest a commit message (and Copilot may assist, if enabled). Review or edit the message, then click "Proceed" to commit to your forked repository:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
4. Copilot will generate a commit message for your edits. Click "Proceed" to accept the edits, and commit them to your forked repository:
<img width="815" height="763" alt="image" src="https://github.com/user-attachments/assets/660740d4-2001-4489-9844-1f7f3b44fa61" />
4. GitHub may suggest a commit message (and Copilot may assist, if enabled). Review or edit the message, then click "Proceed" to commit to your forked repository:
<img width="815" height="763" alt="image" src="https://github.com/user-attachments/assets/660740d4-2001-4489-9844-1f7f3b44fa61" />
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 33 - 34, The sentence "Copilot will generate a commit
message for your edits" should be made non-mandatory—update the wording in the
README (the sentence in the commit step) to present Copilot-generated commit
messages as an optional fallback (e.g., "Copilot can generate a commit message
for your edits" or "You may use Copilot to generate a commit message"), so the
instruction is accurate for all users and accounts.


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".
<img width="1828" height="451" alt="image" src="https://github.com/user-attachments/assets/c4ba1f97-9349-4676-a4cd-1869460b99c0" />

- 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

Expand Down
Loading