posit-dev / posit-dev/connect-extensions
Update quarto-document, fold pqr into it
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 10
- Forks
- 8
- Avg merge
- 5d 18h
- Merged PRs (30d)
- 1
Description
Polish quarto-document and fold relevant parts of pqr (R + Python polyglot demo) into it before deleting standalone pqr. This is the one basic Quarto authoring starter (Mermaid + OJS).
Here is a non-exhaustive list of things we'll want to make sure are completed:
- README: rewrite into 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 comparing the quarto-document and pqr extensions, then read their README files and source comments to identify the relevant material to fold together. Done means quarto-document has the useful setup, usage, and purpose documentation, the requested title and description are in place, the source is well commented, and standalone pqr is removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, r
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100