Add documentation landing page to replace directory listing#143
Add documentation landing page to replace directory listing#143Phanindra899 wants to merge 3 commits intoapache:masterfrom
Conversation
|
Hi @henrikingo, This PR adds a structured landing page for the docs to improve navigation and onboarding. Happy to refine the approach or make any changes based on your feedback. Thanks! |
|
Can you generate this from docs/README.md? If someone wants to add one more file to docs, like JSON.md say, they should only need to add that file into one table of contents. Other formats shold be a copy of the original one, or derived from it. |
|
What is the value of putting an index page into this repo? If someone wants raw markdown, it is already there. I thought the point of that issue was to fix https://otava.apache.org/docs/, but then the fix should be in https://github.com/apache/otava-website. |
|
Hi @henrikingo , Thanks for the feedback — that makes sense. I’ve updated the landing page to remove the manually structured content and instead reference docs/README.md as the source of truth, avoiding duplication. However, I wanted to confirm: Happy to adjust the approach accordingly. |
This PR adds a structured documentation landing page for the docs directory.
Currently, the docs URL renders a raw directory listing, which makes navigation difficult. This change introduces a simple and clear entry point that organizes links to key documentation sections.
The implementation is intentionally minimal and avoids introducing additional dependencies, keeping it aligned with Apache project practices.
All links directly reference the existing documentation files, ensuring consistency with the current structure.