Orange-OpenSource / Orange-OpenSource/ouds-android
[Documentation] Add a section on the home page to visually explain OUDS usage
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 22
- Forks
- 5
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 30
Description
Add a new section in index.html "Getting started" to display this diagram:
The aim is to have a visual explanation of the main packages. Maybe we should add some text below the diagram to say that the things needed to use OUDS Android are in the core package: usable semantic tokens and components.
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
Open index.html and locate the home-page content where a new “Getting started” section belongs. Use the provided diagram and consider the suggested explanation that the core package contains the semantic tokens and components needed for OUDS Android; done means the section is visible on the home page with the diagram and explanatory text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100