nebari-dev / nebari-dev/nebari-docs
[DOC] - Review and update navigation structure
Open
Nobody has claimed this yet.
area: documentation 📖
type: maintenance 🛠
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
The docs have grown organically a bit over the past year, it'll be good to review the navigation, update the learning paths, and restructure as needed.
#359 is also related.
Steps to Resolve this Issue
- Review the current structure and propose updates in this issue and open new issues if documentation gaps are identified
- Update the learning paths: https://www.nebari.dev/docs/welcome#learning-paths
- Restructure pages into different sections, improve the titles, etc., as needed
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 navigation and the learning paths at https://www.nebari.dev/docs/welcome#learning-paths, with related issue #359 for context. Propose navigation and learning-path updates in this issue, identify documentation gaps as new issues, and restructure pages or improve titles where needed.
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
- Mostly clear
- Newbie friendliness
- 35/100