posit-dev / posit-dev/py-shiny
Improve navset documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
As pointed out by @vnijs on Discord, the navset documentation showcases all of the navset options at the expense of being hard to copy and paste during app development.
Would be great to have a simple example in the documentation of a navbar page with a sidebar layout. The current example in the documentation is a bit complex https://shiny.posit.co/py/api/ui.nav.html#shiny.ui.nav.
In bslib, I separated the examples into individual examples that are easier to copy and paste in https://github.com/rstudio/bslib/pull/521
Contributor guide
No contributing guide indexed for this repository
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 with the ui.nav documentation page linked in the issue and review how its current example presents navset options. The bslib pull request provides a reference for separating examples. Done means the documentation includes a simpler, copy-and-pasteable navbar page example with a sidebar layout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100