Skip to content

[R][Documentation] Improve text in top-level package README #35875

@amoeba

Description

@amoeba

Describe the enhancement requested

As discussed on the 2023/06/01 Arrow R package development sync call, a reworking of the top-level README might make it easier for potential users of the package to understand what they can do and more likely for them to become users. While the current content gives a good overview, there are some areas it could be improved:

  1. Move the discussion of Apache Arrow itself lower down
  2. Describe a smaller and denser list of features, some could be combined, some could be moved or removed. Maybe five or so
  3. Link each feature to more detail about how to use that feature

The sparklyr package website was brought up as an example and I think it's a good one. It lists a denser feature set and links to internal documentation for each. Their guides section was also brought up because of how it organizes guides.

Please comment if you have any ideas or suggestions.

cc @thisisnic @stephhazlitt @fmichonneau

Component(s)

Documentation, R

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions