nebari-dev / nebari-dev/nebari-docs
The documentation style might be outdated on breaking lines
Open
Nobody has claimed this yet.
area: documentation 📖
type: bug 🐛
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Describe the bug
The documentation style mentions:
but the linked location does not have a line break link that:
Expected behavior
Example is embedded in the style guide instead to avoid link to
How to Reproduce the problem?
Visit https://www.nebari.dev/docs/community/style-guide/
Command output
No response
Versions and dependencies used.
No response
Anything else?
No response
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
Open docs/docs/community/style-guide.md at the referenced section and compare it with the line-break example in docs/docs/how-tos/domain-registry.md around lines 87–108. Update the style guide so the example is embedded there rather than relying on the outdated link, then verify the rendered community style guide no longer points to that location.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100