nebari-dev / nebari-dev/nebari-docs
[DOC] - Create templates for diataxis: tutorials, how-tos, conceptual guides, references
Open
Nobody has claimed this yet.
area: documentation 📖
good first issue
help wanted
type: enhancement 💅🏼
- 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
Templates can help with consistency, and reduce the barrier to contributing new docs pages.
This will be an extension of #153.
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 existing Nebari documentation structure. Create templates for Diátaxis tutorials, how-tos, conceptual guides, and references; done means contributors have a consistent template for each of the four documentation types.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100