posit-dev / posit-dev/commons

adopt the trust diagram svg from the shared website into the README and R documentation

Open Beginner friendly
#375 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tidy-dev-day 🤓
Dominant language
Python
Stars
44
Forks
1
Avg merge
1d 7h
Merged PRs (30d)
142

Description

On the website, there's a diagram that looks like this:

Image

There are similar diagrams in the README(s?) and the Getting started vignette on the R side that this one was derived from. We should switch those out for this new one.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing trust diagrams in the README(s) and the R-side Getting started vignette, then compare them with the attached website diagram. Replace the existing diagrams with the new SVG and verify that both the README documentation and the vignette display the updated diagram.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.