nebari-dev / nebari-dev/nebari-docs
ENH - Nicer documentation sections overviews
Open
Nobody has claimed this yet.
area: documentation 📖
good first issue
type: enhancement 💅🏼
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Something like: https://www.gatsbyjs.com/docs/how-to/
Originally posted by @pavithraes in https://github.com/nebari-dev/nebari-docs/issues/10#issuecomment-1267148777
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 current documentation section overview pages and compare their organization with the linked Gatsby how-to example. Define a consistent overview structure and update the relevant sections; done means the section landing pages provide clearer, more useful overviews.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100