ImperialCollegeLondon / ImperialCollegeLondon/FINESSE_processing
Add documentation framework + publish to GitHub pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
There is existing documentation for the old code, but it would be useful to have this published somewhere -- GitHub Pages is the easiest way to do this.
We can include both user manuals, installation instructions etc. along with API documentation.
I'm going to suggest we use MkDocs for this as it's what we usually use.
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 by reviewing the existing documentation for the old code and the repository's Python API surface. Evaluate the proposed MkDocs and GitHub Pages approach, then define the documentation structure for user manuals, installation instructions, and API documentation. Done means the documentation is published and accessible through GitHub Pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100