Revamp documentation
Open
Nobody has claimed this yet.
documentation
help wanted
- Dominant language
- Python
- Stars
- 176
- Forks
- 40
- PR merge metrics
- No merged PRs in 30d
Description
Create the following documentation pages:
- getting started: intro
- getting started: installation
- getting started: rename basic usage -> quickstart, add a bit on hyperparameters
- advanced usage: basic concepts
- advanced usage: hyperparameters
- advanced usage: tuners -> extend this in depth
- advanced usage: selectors -> extend this in depth
Reorganize tree, see MLBlocks.
See also: https://hdi-project.github.io/MLBlocks/
See also: #52
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
Review the requested getting-started and advanced-usage pages, the existing documentation tree, MLBlocks, and issue #52 before planning the reorganization. Done means all listed pages are created or expanded, the getting-started naming is updated, and the documentation tree reflects the new structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, machine-learning
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100