Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearer documentation on making suggestions for improvements to documentation #135

Open
hturner opened this issue Apr 6, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hturner
Copy link
Member

hturner commented Apr 6, 2023

Is your feature request related to a problem? Please describe.
Currently it is not clear from the guide how to contribute suggestions for improvements to R's documentation.

Describe the solution you'd like

  • In What is a Bug? we should say "If documentation is incorrect or unclear, this is a bug". Review the rest of this chapter to makes sure it is clear how to report a bug in the documentation
  • In the documentation chapter we should make clear that people can contribute by making suggestions (refer back to bug chapter) and not just addressing existing issues.

Describe alternatives you've considered
We could limit the documentation of this issue to the Documentation chapter - probably this is where people will look first. In which case, we would still refer back to the Bug Tracking chapter for general information on Bugzilla/Bug tracking, but add clear sections on reporting bugs, suggesting improvements and contributing to the documentation. Then would could link people straight to the relevant section for help.

Additional context
N/A

@hturner hturner added the documentation Improvements or additions to documentation label Apr 6, 2023
@SaranjeetKaur
Copy link
Collaborator

Review the documentation and the bug tracking chapters to see if this has been addressed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants