Revise overview page
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
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.
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/
- Dominant language
- No language data
- Stars
- 14
- Forks
- 58
- Avg merge
- 1h 4m
- Merged PRs (30d)
- 21
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from OpenLiberty/docs
-
source mismatchOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
OpenLiberty/docs#8579 ·
Maintainers usually reply within 1 day
-
Jandex extended pathOpen
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
OpenLiberty/docs#8451 · 1 comment ·
Maintainers usually reply within 1 day
-
CVE update for 26.0.0.10Possibly taken @ramkumar-k-9286 claimed this 18 days ago. Open26.0.0.10
OpenLiberty/docs#8563 · 5 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
26.0.0.11
Difficulty 5/5 Over a week Newbie friendliness 25/100
OpenLiberty/docs#8548 ·
Maintainers usually reply within 1 day
-
26.0.0.12
Difficulty 4/5 3-5 days Newbie friendliness 45/100
OpenLiberty/docs#8529 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenLiberty/docs
Similar issues
-
Remove DatacircleOpen
Difficulty 1/5 Under an hour Newbie friendliness 90/100
collabnix/awesome-mcp-lists#230 ·
Maintainers usually reply within 9 days
-
beginner-friendly category:finding-titles community enhancement first-timers-only good first issue hacktoberfest help wanted low hanging fruit micro-contribution type: task up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 94/100
Berserk-hub150/skillhawk#226 · 1 comment ·
Maintainers usually reply within 8 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ianktoo/project-monitor#14 ·
-
documentation good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
steerion-labs/bounded-agent-runtime#93 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
kaimahi-agents/kaimahi#570 ·
Maintainers usually reply within 1 day