posit-dev / posit-dev/shinyreact
Docs site: brand.yml styling for the Quarto / pkgdown / TypeDoc pages
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 14
- Forks
- 3
- Avg merge
- 9h 12m
- Merged PRs (30d)
- 74
Description
Follow-up to #86. The docs site (Quarto landing + quartodoc at /py/, pkgdown at /r/, TypeDoc at /js/) ships with stock themes: Quarto cosmo, pkgdown Bootstrap 5 default, TypeDoc default.
Give it one look across all three:
- Add
_brand.yml(colors, fonts,logo/shiny-react.svg) and switchpkg-py/docs/_quarto.ymltotheme: [brand](shinychat does this) - Point
pkg-r/_pkgdown.ymlat the same brand file (template: brand:is supported by pkgdown ≥ 2.1) - TypeDoc:
customCssmatching the brand palette, or accept the default - Logo in the Quarto navbar / pkgdown home
- Set the repo
homepageUrlto https://posit-dev.github.io/shinyreact/ once the first deploy lands
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 comparing shinychat's brand setup, then inspect pkg-py/docs/_quarto.yml and pkg-r/_pkgdown.yml for the Quarto and pkgdown theme configuration. Check the TypeDoc configuration and the existing shiny-react.svg logo before deciding whether customCss is needed. Done means the three documentation areas share the intended branding, the logo is placed where specified, and homepageUrl is set after the first deploy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100