nebari-dev / nebari-dev/nebari-docs
[DOC] - Update docs to follow the new documentation style guide
Open
Nobody has claimed this yet.
area: documentation 📖
good first issue
impact: low 🟩
- 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
After #153 is in, we will need to go through the current docs to make sure they align with the guidelines.
Steps to Resolve this Issue
N/A
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 issue #153 and the current documentation to identify the new style guide and the pages it affects. The issue provides no file list, test target, or concrete checklist; done would mean the relevant docs have been reviewed and updated to match the new guidelines.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100