OpenLiberty / OpenLiberty/docs
Revise overview page
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 4m
- Merged PRs (30d)
- 35
Description
The docs page (https://openliberty.io/docs/latest/overview.html) has a lot of good content. However, a lot of that TOC is off-screen when initially viewing the page and user needs to scroll to see all the important topics. I think the "Welcome to Docs" page can be improved to show the key (or popular) topics right on that page - e.g. assembled in a set of tables. Example: https://learn.microsoft.com/en-us/azure/developer/java/ee/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the overview page at https://openliberty.io/docs/latest/overview.html and review how its table of contents presents topics above the fold. Compare its organization with the linked Microsoft example, then identify the key or popular topics to surface. Done means the Welcome to Docs page presents those topics in useful tables without requiring users to scroll through the existing off-screen TOC.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100