mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
Merge pull request #3449 from mhilbrunner/fix-contrib-guide-layout
Fix documentation guidelines to not break layout
This commit is contained in:
@@ -39,9 +39,10 @@ reference documentation about the reStructuredText markup language.
|
||||
The 'Edit on GitHub' link
|
||||
-------------------------
|
||||
|
||||
If you're reading documentation on ``docs.godotengine.org``, you'll see an
|
||||
**Edit on GitHub** hyperlink at the top right of the page. Once you've created a
|
||||
GitHub account, you can propose changes to a page you're reading as follows:
|
||||
If you're reading documentation on `docs.godotengine.org <https://docs.godotengine.org>`_,
|
||||
you'll see an **Edit on GitHub** hyperlink at the top right of the page.
|
||||
Once you've created a GitHub account, you can propose changes to a page you're
|
||||
reading as follows:
|
||||
|
||||
1. Click the **Edit on GitHub** button.
|
||||
|
||||
@@ -55,11 +56,11 @@ GitHub account, you can propose changes to a page you're reading as follows:
|
||||
click the button labelled **Propose file change** when done.
|
||||
|
||||
5. On the following screens, click the **Create pull request** button until you
|
||||
see a message like ``Open. yourGitHubUsername wants to merge 1 commit into
|
||||
godotengine:master from yourGitHubUsername:patch-6``.
|
||||
see a message like *Username wants to merge 1 commit into
|
||||
godotengine:master from Username:patch-6*.
|
||||
|
||||
6. A reviewer will evaluate your changes and incorporate them into the docs if
|
||||
they're judged to improve them. You might also be asked to make
|
||||
they're acceptable. You might also be asked to make
|
||||
modifications to your changes before they're included.
|
||||
|
||||
What makes good documentation?
|
||||
|
||||
Reference in New Issue
Block a user