Open-EO / Open-EO/openeo-python-client
Documentation improvements
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
A couple of ideas to improve the docs at https://open-eo.github.io/openeo-python-client/
- landing page is now just table of contents, we probably should make it more compelling with a bit more text/images
- add link to changelog (e.g see structlog https://www.structlog.org/en/stable/changelog.html )
- integrate working examples in some way (embed scripts directly, embed notebooks)?
- any quick way to visually align better with openeo.cloud?
- better, more modern theme (e.g. furo as metnioned in #294)
Contributor guide
No contributing guide indexed for this repository
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 with the documentation site at https://open-eo.github.io/openeo-python-client/ and compare its presentation with https://docs.openeo.cloud/. Review the linked structlog changelog example and the Furo suggestion in #294. The issue needs a defined subset of improvements and explicit acceptance criteria before work can be considered done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100