OpenEnergyPlatform / OpenEnergyPlatform/omi
OMI's documentation is outdated
Open
Nobody has claimed this yet.
part: docu :book:
priority: low :sloth:
status: blocked :stop_sign:
type: enhancement :gear:
- Dominant language
- Python
- Stars
- 8
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
The current docs seem to be outdated (0.0.2, changelog says 0.0.0).
Also, the docs would really benefit from some more explanations and references.
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 documentation at https://omi.readthedocs.io and comparing its version information with the changelog. Update the outdated version and changelog details, then add the explanations and references requested in the issue; done means the documentation accurately reflects the project and provides the missing context.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100