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

Add "Report" option for incorrect/insufficient documentation #1241

Open
tadman opened this issue Oct 18, 2022 · 2 comments
Open

Add "Report" option for incorrect/insufficient documentation #1241

tadman opened this issue Oct 18, 2022 · 2 comments

Comments

@tadman
Copy link

tadman commented Oct 18, 2022

It'd be nice if documentation that was incorrect or just extremely thin, as can be the case in some parts, could be reported/flagged/highlighted.

APIDock has (had?) comments that helped somewhat with this, as additional explanations could be provided, but some kind of basic flagging tool could at least help collect data that could inform what parts of the documentation need more attention.

@colby-swandale
Copy link
Member

colby-swandale commented Oct 23, 2022

I would like to see something added that addresses this, thanks for opening an issue about this.

In the past I've thought about having a button/form that people can submit that indicates that some piece of documentation is laking somehow, and have some tooling that ultimately is actionable for someone to help contribute documentation back to ruby-src. I think it would be a huge win if we can make it easy, and celebrate/promote people.

@tadman
Copy link
Author

tadman commented Oct 24, 2022

If there was just a tumbleweed button you could click if the documentation left you feeling hopeless and alone, even if it didn't do anything, that'd be a win in my book.

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

No branches or pull requests

2 participants