datacamp / datacamp/rdocumentation-2.0
Rdocumentation - page structure
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 301
- Forks
- 54
- Avg merge
- 16h 19m
- Merged PRs (30d)
- 1
Description
Is it just me or the whole documentation document structure is not feasible? There is too much text and no easily followed code.
https://www.rdocumentation.org/packages/ggvis/versions/0.4.7/topics/group_by
https://www.rdocumentation.org/packages/base/versions/3.6.2/topics/data.frame
versus
https://www.geeksforgeeks.org/types-of-vectors-in-r-programming/
https://bookdown.org/ejvanholm/Textbook/descriptive-statistics.html#practice-1
https://www.w3.org/TR/2012/NOTE-WCAG20-TECHS-20120103/H86
https://www.w3schools.com/css/css_colors.asp
https://bookdown.org/content/d1e53ac9-28ce-472f-bc2c-f499f18264a3/func.html
The detail page of the documentation is just awful. I am sorry, but it is. It should be easily followed, understandable, and should include one code example per function argument with an interactive example. Also maybe a downloadable R code. Make the code snippet editable through webpage embedded Datacamp editor (input + output).
If the document structure is easily followed, and understandable - most people won't need to post in Stack Overflow.
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 linked RDocumentation detail pages with the reference documentation examples in the issue. No repository files, tests, or entry points are named, so identify the detail-page implementation before scoping the work. Done would require an agreed page structure and defined scope for examples, interactivity, and downloadable R code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100