Hi Jacopo,
BTW, that changed when you added
https://github.com/apache/ofbiz-framework/blob/trunk/.github/README.md.
Before https://github.com/apache/ofbiz-framework/blob/trunk/README.adoc showed.
So the question is: should prefer one or the other?
I believe the README.adoc should be preferred.
Because it shows what OFBiz is and its status.
When README.md is only about our GitHub CI/CD Configuration.
The second is of less interest for new comers and visitors.
Jacques
Le 31/03/2026 à 16:42, Jacques Le Roux via dev a écrit :
We can try
Jacques
Le 31/03/2026 à 12:29, Ashish Vijaywargiya a écrit :
+1
Thanks,
Ashish Vijaywargiya
On Tue, 31 Mar 2026 at 15:25, Jacopo Cappellato <[email protected]>
wrote:
Hi all,
I’ve noticed that because we currently have a README.md file inside the
.github/ folder, that file is being displayed on the landing page of the
project (https://github.com/apache/ofbiz-framework) instead of the
README.adoc located in the root directory.
One possible workaround would be to rename .github/README.md to avoid this
unintended behavior. However, I’d like to propose a different approach:
converting the root README.adoc (AsciiDoc) into a README.md (Markdown).
This change could improve compatibility with GitHub’s default behavior and
make the project more accessible to a wider audience, since Markdown is
more commonly used and immediately rendered as expected on GitHub project
pages.
Of course, this would also require evaluating any AsciiDoc-specific
features currently in use and ensuring they are properly translated or
adapted.
What do you think about this approach?
Best regards,
Jacopo
