Comments (9)
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.
Related Issues (20)
- Addons: remove the "beta" from it HOT 2
- Docs: Write initial Addons documentation page HOT 1
- Document serve failed today HOT 6
- Impossible to build `latest` after changing some options and putting them back as before HOT 2
- Submodule documentation is no longer being generated. HOT 1
- Mamba related install issues HOT 8
- ReadTheDocs hosted website marked as potentially hacked by Google HOT 5
- Addons: remove "beta" label from it HOT 1
- Docs: kill "Choosing between our two platforms" and link to `about.` HOT 8
- Subscriptions: add test for Slack API integration on subscription canceled
- Read the Docs Addons enabled by default and injected Sphinx context removal HOT 6
- Bulk deactivate/hide versions HOT 3
- error: [Errno 2] No such file or directory: 'cargo' when installing build with uv HOT 3
- Notifications: removing a message causes unwanted unknown message notification HOT 1
- Proxito: use new dashboard templates
- Errors: how to handle porting contextualize 404 error pages
- Upgrade rust build environment to 1.79 HOT 4
- Addons: de-activating/hiding a version doesn't purge the cache
- Addons: consider adding subprojects-related data to API response HOT 1
- Version warning banners not showing HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from readthedocs.org.