Orange-OpenSource / Orange-OpenSource/IOT-Map-Component
Add a documentation website
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 24
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Description
Study how to add a documentation website able to handle versioning as well. Right now, the documentation of the library is a bit hidden in a Markdown document.
If it can be done, analytics should be added as it's been done in https://github.com/Orange-OpenSource/ods-android/pull/807 for instance.
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 reviewing the current Markdown documentation and the referenced analytics example in ods-android pull request 807. Define the scope for a versioned documentation website, then determine whether analytics fits; done means the documentation is available through that site with versioning and analytics if feasible.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100