Set up initial documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
Research direction
Start by resolving the three questions in the issue: the repository's purpose, how documentation and tutorials should be divided, and whether to use MkDocs or mdBook. There are no files or tests named in the issue. Done means the documentation scope, tutorial location, and GitHub Pages tooling have been agreed.
Written by the indexing model from the issue text.
Description
At some point, we will probably want the code and notebooks in this repo to have documentation on GitHub Pages.
We will need to work out a few things before we do that, namely:
- What do we want this repo to be for? Are we going to publish a Python package or is it just example Jupyter notebooks etc.?
- How are we going to divide the documentation between this repo and the main one? Where should tutorials live?
- What tooling do we want to use for this? MkDocs is the obvious choice (there is also a plugin for notebooks), but we could also go with mdBook, as we've done for the main repo, for consistency.
My feeling about 2 is that it probably makes sense to have tutorials in this repository, as we will want to walk users through analysing the data, which will be easier if we embed Jupyter notebooks.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 17h 5m
- Merged PRs (30d)
- 11
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.
More from EnergySystemsModellingLab/muse2_data_analysis
-
EnergySystemsModellingLab/muse2_data_analysis#59 · 1 assignee ·
All issues in EnergySystemsModellingLab/muse2_data_analysis
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100