Orange-OpenSource / Orange-OpenSource/ouds-android
Documentation - not found version
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 22
- Forks
- 5
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 30
Description
Documentation Location
Within a page of a component documentation, when a user selects a different version of the documentation and the item did not exist in the previous version a dedicated page appears as follows:
Current issue
The page is modeled around an error like the 404 error and it is not easily visible that this item did not exist in this version
Expected Correction
Working with @Franco-Riccitelli we should see if it is possible to update the page so that it can reflect the new orange design style and better explain the issue:
"In this version of the OUDS-Android Library - v0.1.0, the item you are look for did not yet exist.
Please go back to the previous page to navigate i the rest of the documentation."
Or something along those lines.
Additional context
No response
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 by locating the component documentation page shown when a selected version lacks the requested item, then trace how that not-found page is generated. Update its visual treatment to match the orange design and make the version-specific explanation and navigation guidance clear; verify the page in the affected documentation flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100