there should be a way to give feedback to docs about readthedocs.org HOT 9 CLOSED

Agreed. We have comments in a working state, but they usually become a wreck pretty quickly. I really want to have the ability to have a basic editing interface for the docs so that users could even fix typos and send the author a diff. This is on the list of things to do.

from readthedocs.org.

Yes, that would be absolutely amazing. Some ways to edit sphinx docs.

from readthedocs.org.

-1 on this one. the docs are usually part of a repo. with the repo (being hosted on github, google-code, bitbucket, ...) there´s an issue-tracker for comments/feedback. as an author/maintainer of a project, if I need to check rtfd.org for further feedback it´s getting confusing.

@ericholscher (about fixing typos and other minor improvements): that´s what the repository is there for.

sorry if I don´t get the point.

from readthedocs.org.

sehmaschine:

I actually implemented a way that uses github to handle it, but still allows you to edit stuff on RTD:

• User does a bunch of changes on RTD
• The changes are pushed to an RTD account on github
• That account sends a pull request with the changes to the repository.

from readthedocs.org.

I understand that a comments feature is part of Sphinx 1.1 (http://sphinx.pocoo.org/latest/web/quickstart.html#comments-proposals). There's an example web app at http://www.jacobmason.com/demo/contents.

from readthedocs.org.

Is this likely to actually get rolled out in the near future (and if it needs work, can I help)? This sounds like exactly what I'm looking for to help users point out and fix problems / omissions in my documentation.

from readthedocs.org.

Maybe we should sprint on this at djangocon us

from readthedocs.org.

That could be great (though I won't be there, I might be able to help remotely).

from readthedocs.org.

+1 :)

from readthedocs.org.