datacamp / datacamp/rdocumentation-2.0
README not parsed?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 301
- Forks
- 54
- Avg merge
- 16h 19m
- Merged PRs (30d)
- 1
Description
For some packages README is shown correctly e.g. for dplyr at https://rdocumentation.org/packages/dplyr/versions/1.0.10 For some other packages, e.g. ergm https://www.rdocumentation.org/packages/ergm/versions/4.3.2, the website shows only Description field of DESCRIPTION even though the sources has the README.
Is this a website glitch or rendering README needs to be switched on somehow?
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
Compare the dplyr and ergm package pages linked in the issue, then trace the website's README-versus-DESCRIPTION rendering path. Done when ergm's available README is displayed rather than only its DESCRIPTION field, with the behavior checked against both examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100