Move root README to the 'notebooks' folder, replace with a general README
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Jupyter Notebook
- Stars
- 96
- Forks
- 41
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 6
Description
The original README contains links to each notebook, stored in the 'notebooks' subfolder. However, since more subfolders have been added with their own READMEs, this suggestion proposes to move that README into the 'notebooks' folder, and have a general README in the root directory containing descriptions and links to each subfolder and other information.
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 root README and the README files in the notebooks and other subfolders. Move the notebook-specific content into the notebooks folder, then create a general root README with descriptions and links to each subfolder and its README; verify that all links remain correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100