Allow editing the class reference documentation from the Godot Editor (or similar) #12273
azur-wolve
started this conversation in
Editor
Replies: 1 comment
-
This sounds very complex to implement. Remember that there are already many documentation guidelines to follow to contribute to the class reference, so even if you got the technical hurdles out of the way, you are still expected to read the guidelines before opening a pull request. If we redirect users to a GitHub page directly, we can't make sure users will have read the guidelines before opening a pull request (or are even aware of them). |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
One of the main reasons why there are no much contributions to the Godot documentation is because must read extensive documents before can get started.
That offers a big resistance to contribute.
What about instead offer the lesser resistance path?
Being able to edit documentation in some sort of embedded text editor (like the one using here in GitHub to write this proposal), would increase the number of contribution from the community.
That would suppose a huge improvement in the quality of the documentation.
I was thinking mostly about the scripting API reference, but its in general.
Something like being able to click a button from the integrated API in the Godot Editor and edit some sections of text, and then click another button that invokes the web browser opening a link to GitHub with a template ready to make a PR would be great.
That would work only for the scripting API.
But something similar in the Godot Docs that allow to redact conveniently using a template with the style conventions and so on, to either edit or create new pages or sections.
Beta Was this translation helpful? Give feedback.
All reactions