apache / apache/arrow

[R] pkgdown site improvements

Open
#35,082 1 comment 0 reactions 0 assignees View on GitHub
Component: R Type: enhancement
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

### Describe the enhancement requested

After a number of discussions with folks, some documentation improvements which could be made to the pkgdown site:

- [ ] link to cheatsheet from "getting started" page
- [ ] move "implementations" further down and move up "contributing", CoC, and license (see Distill site as an example)
- [ ] simplify first 2 paragraphs in README page (replace with something 10th-12th grade reading age max)
- [ ] link to R4DS chapter
- [ ] link to Awesome Arrow R

### Component(s)

R

Contributor guide

Open the contributing guide

Research direction

Review the pkgdown site's getting started and README pages, using the listed Distill site as a reference for navigation order. Add the requested cheatsheet, R4DS, and Awesome Arrow R links, simplify the opening README text, and verify the resulting page order and links in the generated site.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.