REditorSupport / REditorSupport/vscode-R

[Documentation] linux installation suggestions

Open Beginner friendly
#1,641 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.2k
Forks
139
Avg merge
2h 46m
Merged PRs (30d)
5

Description

On the installation's entry for linux it (very helpfully) suggest that if you want formated manpages on hover you can download rmarkdown and pandoc (which comes preinstalled with r-studio). For those who do not have R studio they'd be surprised to learn that pandoc depends on haskell, and thus the base package and it's dependencies can weigh up to 500mbs. I think it's a bit silly to suggest a large package just for syntax highlighting on function manpage tooltips (something which has native and less heavy alernatives on linux), but I also think the observation is relevant for those who might wonder why their mangpages are in plain text.

I think this can be edited to be part of the installation but not in the order of the default installation steps, but rather a suggestion or a note somewhere else in the doc. I can do this as the pages are editable but I'd like to know if it's ok first!

I believe the changes were made by @18kimn

Contributor guide

Open the contributing guide

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

Open the Installation: Linux wiki page linked in the issue and review where rmarkdown and pandoc are presented in the default installation steps. Move or reframe that guidance as an optional suggestion or note, including the potential dependency size; done means Linux users can distinguish the optional formatted-manpage setup from the default installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell, linux, r
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.