UCL / UCL/rsd-engineeringcourse
Move away from Jupyter notebooks
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
Notebooks are very suited for demonstration, but not ideal when it comes to maintaining and reusing the material. We have for a while discussed switching to another system, such as Sphinx. This is for tracking ideas and notes.
Sphinx
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 reading the initial Sphinx attempt in issue #155 and reviewing the existing notebook-based course material. The issue names no files or tests; done would require agreeing on the replacement system and a concrete migration scope, including the reStructuredText and Mermaid considerations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100