posit-dev / posit-dev/connect-extensions
Replace 5 examples with new content
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 10
- Forks
- 8
- Avg merge
- 5d 18h
- Merged PRs (30d)
- 1
Description
We want to make sure the Gallery content is useful/compelling for users, and one way to do this is to vary the industries that are represented with our content.
We want to replace the following 5 examples with new content:
stock-report-jupyter: Jupyter (jupyter-static) & Academic / Research. Reproducible research analysis: notebook to narrative + styled tables.quarto-stock-report-r: Quarto report (R) & Government / space (NASA). NASA Earth-observation / near-Earth-object briefing, part of R+ Python parity pair for Quarto reports.quarto-stock-report-python: Quarto report (Python) & Government / space (NASA). NASA Earth-observation / near-Earth-object briefing, part of R+ Python parity pair for Quarto reports.stock-dashboard-python: Python Dash & Insurance. Claims / catastrophe-risk dashboard.top-5-income-share-streamlit: Streamlit & Manufacturing. Production-line / operations dashboard.
Note that for the Quarto report pair, if we decide it's a good idea, we could fold Typst into the 2 Quarto report examples (R / Python). Each would render both HTML and PDF from one source (Quarto auto-links the PDF download), show off equations/cross-refs/citations in the typeset output, and regenerate on a schedule.
Here is a non-exhaustive list of things we'll want to make sure are completed for these 5:
- README: make it a genuinely useful doc: what the tool does, who it's for, setup/configuration, and how to use it.
- Well-commented source: comments should explain the why, not just the what.
- Title: in Framework: Functionality form.
- Description: concise; states the functionality and value. Where relevant, names a themed industry with an "applies to any …" cue.
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 locating the five named Gallery examples and their README and source files, then review comparable examples to understand the expected structure. Replace the examples with the proposed industry-focused content and ensure each has useful setup and usage documentation, why-focused source comments, a Framework: Functionality title, and a concise value-oriented description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, python, r, streamlit
- Domain
- content, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100