Implement the Android Wave and Whale documentation reader
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- android
- Domain
- documentation, mobile
Research direction
Start with frontend/src/services/documentNavigation.ts, its test fixtures, and issue #83, after checking prerequisites #81 and #82. Use synthetic documents to trace catalogs, detail fallback, navigation state, and error distinctions. Done means the listed online-reading behaviors are covered without adding offline bundles, sharing, or verified App Links.
Written by the indexing model from the issue text.
Description
Roadmap: #76
Outcome
Read public documentation with the same navigation contract as the website.
Done
- Provide project catalogs and a safe Markdown/detail reader with headings, code blocks, and links.
- Classify only paths beginning
whale/as Whale; keep other paths in Wave. - Merge translated metadata over English by path, sort by group_order/order/path, and limit navigation to the active project.
- Fall back to English detail only on 404 and visibly identify fallback content.
- Preserve selected project, document locale, route, and reading position across rotation/recreation.
- Distinguish empty catalogs, missing details, unavailable service, and cancellation; test with synthetic documents.
Start: frontend/src/services/documentNavigation.ts, its test fixtures, and #83. This task is online reading; offline bundles, sharing, and verified App Links have separate issues.
Prerequisites: #81, #82, #83.
- Dominant language
- Go
- Stars
- 1
- Forks
- 7
- Avg merge
- 6h 25m
- Merged PRs (30d)
- 18
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
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 wavefnd/wave-platform
-
bug difficulty: beginner documentation good first issue help wanted localization
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
wavefnd/wave-platform#139 ·
Maintainers usually reply within 1 day
-
bug difficulty: beginner documentation good first issue help wanted localization
Difficulty 2/5 Half a day Newbie friendliness 88/100
wavefnd/wave-platform#137 ·
Maintainers usually reply within 1 day
-
bug difficulty: beginner documentation good first issue help wanted localization
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
wavefnd/wave-platform#136 ·
Maintainers usually reply within 1 day
-
bug difficulty: beginner documentation good first issue help wanted localization
Difficulty 1/5 Under an hour Newbie friendliness 94/100
wavefnd/wave-platform#135 ·
Maintainers usually reply within 1 day
-
bug difficulty: beginner documentation good first issue help wanted localization
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
wavefnd/wave-platform#133 ·
Maintainers usually reply within 1 day
All issues in wavefnd/wave-platform
Similar issues
-
automation models
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
txn2/mcp-data-platform#1984 ·
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
kind/docs prio/P2
Difficulty 1/5 Under an hour Newbie friendliness 95/100
agent-substrate/substrate#1986 ·
Maintainers usually reply within 1 day