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

Option to add a comments/feedback form to each documentation page #2533

Closed
brechtm opened this issue Nov 30, 2016 · 1 comment
Closed

Option to add a comments/feedback form to each documentation page #2533

brechtm opened this issue Nov 30, 2016 · 1 comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@brechtm
Copy link

brechtm commented Nov 30, 2016

A feedback form at the bottom of each page could help improve documentation. An example of this is the PHP documentation.

Notes can be used to:

  • signal that a particular part is not clear
  • suggest improvements
  • provide additional information

Some ideas and remarks:

  • notes could be flagged to indicate their type (comment, suggestion, extra-info)
  • notes can be public (viewable by everyone) or private (viewable only by the project owner)
  • public notes can be up/downvoted
  • all notes can be forced to be private by the project owner
  • notes could be attached to specific paragraphs, so that readers can view only those relevant to what (s)he is reading
  • how to handle this across documentation for several project versions?

The sphinxcontrib-disqus extension offers something similar, but this can be improved upon.

@humitos
Copy link
Member

humitos commented Mar 25, 2018

Since #3618, I'd say that this is not longer going to be implemented by RTD core team. I'm closing this here, but feel free to reopen if you consider.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants