Allow user comment threads on documentation website #4178
Replies: 3 comments 3 replies
-
Documentation is one of the favorite jobs of the Godot's documentation team, it is curerntly up to date with features and almost up to date with API reference. Comments on documentation are complicated because those will stay behind changes, need complex moderation, tend to be low quality and is rare to enter the page understanding everything and reach the end with enough experience to give a good answer, so it ends just filling sections with questions and no answers, that is why most modern documentations on this kind of tools just dropped the comments sections. |
Beta Was this translation helpful? Give feedback.
-
There's already a proposal tracking this: #481 I started an implementation a while ago, but I couldn't finish it yet. I can't give an ETA for this being finished. |
Beta Was this translation helpful? Give feedback.
-
Implemented in godotengine/godot-docs#7520. |
Beta Was this translation helpful? Give feedback.
-
Documentation is no ones favorite job. And as a result documentation consistently lags behind features. Additionally, documentation lacks and probably always will lack robust and up to date examples or tips and tricks for implementing features.
The fastest way to receive any sort of answers is in discord but it requires hanging around and hoping someone there can answer your question near the time you have available to hang on discord. That's fine but its not a permanent record and doesn't work for a lot of users. And answers are often going to be necessarily more terse as its a chat platform not a 'stack overflow'
If users could add comments below the documentation for discussions to take place we would be more easily able to make the documentation far more useful and robust without having to involve the developers. It would also provide a resource that could be used to make the documentation above it (and in the editor) more useful without requiring a developers time.
This could super charge a new users ability to get up and running, and help everyone when they get stuck. I think this feature would be a gigantic help to everyone.
Beta Was this translation helpful? Give feedback.
All reactions