QuantEcon / QuantEcon/quantecon-book-theme
DOCS: Clean up Existing Docs and Replace with Options Available to Theme
Open
Nobody has claimed this yet.
high-priority
- Dominant language
- Jupyter Notebook
- Stars
- 56
- Forks
- 24
- Avg merge
- 4h 33m
- Merged PRs (30d)
- 4
Description
@AakashGfude it would be good to clean up the documentation and just consolidate it to a list of options and how to use them.
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
No file, test, or entry point is named. Start by locating the existing documentation and the theme options it describes, then determine how they can be consolidated into a usable list. Done means the existing documentation is cleaned up and replaced with a clear list of available options and instructions for using them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100