posit-dev / posit-dev/py-shiny
Build dev docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 135
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 21
Description
It would be good to build the documentation site on each merge to main, this would serve two purposes:
- It would help people review the documentation in preparation for a release, and we could point people to features which aren't yet released
- We would have confidence that changes to Shiny don't break out documentation process
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 by locating the documentation-site build and the workflow that runs on merges to main. Check how the current documentation process is invoked and how Shiny documentation changes are validated. Done means the site builds on every merge to main and documentation changes no longer break that process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100