From 15a8804da670e6c01b764f685c13441a4301d56c Mon Sep 17 00:00:00 2001 From: Max Hilbrunner Date: Sun, 26 Apr 2020 16:53:29 +0200 Subject: [PATCH] Fix documentation guidelines to not break layout --- community/contributing/documentation_guidelines.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/community/contributing/documentation_guidelines.rst b/community/contributing/documentation_guidelines.rst index de9e357bc..5276127a3 100644 --- a/community/contributing/documentation_guidelines.rst +++ b/community/contributing/documentation_guidelines.rst @@ -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 `_, +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?