godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity
5,455 Commits 21 Branches 0 Tags
3.6
Commit Graph

206 Commits

Author SHA1 Message Date
Igor
d5c22d7f41 Fixes in "Best practices for engine contributors" (#3166) 
There include typos, style tweaks and similar.
 2020-02-13 09:39:01 +01:00
WARIO-MDMA
0b58f6000c Fix grammar issue in "Docs writing guidelines" 
Oh, the irony...
 2020-02-13 12:53:33 +11:00
Juan Linietsky
2f5f2e0ffd Added "Best practices for engine contributors" 2020-02-12 19:17:37 +01:00
Rémi Verschelde
a7dce8ee1e Fix leftovers from 2019 2020-02-08 22:13:17 +01:00
Rémi Verschelde
1df5a0ae68 Merge pull request #3061 from asynts/asynts.syntax-highlighting-2 
Incorrect syntax highlighting for languages other than GDScript.
 2020-01-27 08:39:00 +01:00
Feniks
9c530ae2a8 Updates Godot versions in PR Examples (#3069) 
Updates PR workflow to use more recent examples of Godot versions. We were still talking about 2.1.5 or Godot 3.0.2  so I updates it to more reflect where we are in development.
 2020-01-16 22:28:18 +01:00
asynts
53f878bdaf Replace 'code' directives with 'code-block' directives. 
The `code` directive highlights all sources as GDScript. Other languages are
highlighted incorrectly at the moment, even if `.. code:: [language]` is
specified.

It does, however, work with the `code-block` directive. The reason seems to be
that this directive is Sphinx specific.
 2020-01-13 18:45:39 +01:00
Nathan Lovato
23130deb2d Edit real-world examples in docs_writing_guidelines.rst 
I added missing hyphens, like in made-up, used direct voice, and used a grammar
checker to tweak a paragraph.
 2020-01-13 09:55:22 +01:00
Maciej
ade2a6a260 Expanded guidance about avoiding made up names 
As we discussed here https://github.com/godotengine/godot-docs/pull/3045#discussion_r365111553 I have expanded guidance to mention that we should avoid using made up names and use real world working code examples where practically possible. And where not possible still use a code that at least resembles something you could see in a project.
Update docs_writing_guidelines.rst
 2020-01-13 08:30:59 +00:00
Nathan Lovato
9302b01152 Edit Dynamic vs static typing in docs_writing_guidelines.rst 2020-01-10 19:56:00 +01:00
Feniks
9d452eb42f Added changes about use of Dynamic Typing (#3045) 
* Added changes about use of Dynamic Typing

I have added an explanation directing doc contributors to only use Dynamic typed GDScript in their examples unless they are specifically discussing issues related to static typing.
 2020-01-10 19:42:27 +01:00
Omicron
f7b41ad6ab Adding links to multilingual Discord servers (#2895) 
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
 2019-12-21 11:58:32 +01:00
Jason Yundt
e429494c0e Made "promotion" into an adjective 2019-11-28 18:20:06 -05:00
Probix
3048afcc02 Added New Video Tutorial Playlist 
BornCG is a fantastic teacher who needs to be on this list!
 2019-11-09 22:02:50 -06:00
Rémi Verschelde
ec19eb3335 Merge pull request #2825 from Calinou/update-doc-guidelines-github 
Update documentation guidelines for new simplified GitHub procedure
 2019-10-29 08:58:19 +01:00
sheepandshepherd
edc4d37535 Add a comma and remove hardcoded default value in an outdated example 2019-10-07 00:14:59 +02:00
Hugo Locurcio
045650af90 Update documentation guidelines for new simplified GitHub procedure 
The edit URL is now customizable on Read the Docs, which means
it's no longer necessary to edit the URL manually.
 2019-10-05 18:26:05 +02:00
Max Hilbrunner
b040baa352 Merge pull request #2518 from puchik/pr-workflow-mistake-tip 
Add tip about fixing commit mistakes in PR branches + minor grammar fix
 2019-09-30 00:57:53 +02:00
Tom Glenn
815f925e72 Adds 'Code with Tom' to the list (#2731) 
* Adds 'Code with Tom' to the list

Updates URL to playlist page rather than first video in playlist
 2019-09-02 10:44:17 +02:00
Hugo Locurcio
f5399577a8 Fix Sphinx build warnings related to code blocks 2019-07-28 04:17:36 +02:00
Nathan Lovato
bafd8b654e Contributing to the reference: replace old livestream with new video tutorial 2019-07-15 17:37:58 +02:00
Chris Bradfield
1d5f0aa60e Update text tutorial link 2019-07-05 12:51:56 -07:00
puchik
2f029e5b24 Add tip about fixing commit mistakes in PR branches + minor grammar fix 
- Shortened and made minor grammar fixes to the third paragraph under "Updating your branch" in "PR Workflow"
    - Added a tip regarding fixing commit mistakes in branches that are in pull requests.
 2019-06-15 19:52:49 -07:00
Rémi Verschelde
0bf17179bc Fix duplicate explicit target name errors 
As per the reST spec links with a single trailing underscore are explicit
targets and should not share their name with other links. We need to use
two trailing underscores for those links to works this around.
 2019-06-11 10:56:26 +02:00
Rémi Verschelde
894126a7a6 Bump min clang-format version for contributors 
As per godotengine/godot#29027.
 2019-05-20 13:55:05 +02:00
Max Hilbrunner
6199b963aa Update community channels 
Add #godotenginee-meeting
Fix forum link
Website typo
 2019-05-16 16:50:37 +02:00
Max Hilbrunner
2f25781bfd Update third-party tutorial list 
Small text edits
Add new tutorials
Add Where to start section
Add Devlogs section
Sort listings alphabetically
 2019-05-16 16:40:18 +02:00
Max Hilbrunner
befdb48bc6 Merge pull request #2418 from mitchcurtis/building-docs 
Document how to build the reference documentation
 2019-05-06 15:48:14 +02:00
Mitch Curtis
6bd56df96c Document how to build the reference documentation 
Helps with #2417.
 2019-05-04 22:43:35 +02:00
Rémi Verschelde
1a8d981080 Add link to classref howto 
Fixes #2417.
 2019-04-29 10:21:42 +02:00
bitbutter
8a1c6456cc Update documentation_guidelines.rst (#2342) 
* Update documentation_guidelines.rst

Added section on using Edit on HitHub link for git (and github) noobs like me. Edits welcome if i've made mistake(s).

* Update documentation_guidelines.rst

Changes to github URL editing instructions, and added wording about requests for modifications from reviewers.

* Update documentation_guidelines.rst
 2019-04-15 18:30:16 +02:00
Hugo Locurcio
87d81b9d4a Fix various typos 2019-03-20 01:03:48 +01:00
Rémi Verschelde
4960089d95 Make Community sections more prominent 
Also merge Tutorials and Resources docs.
The new Tutorials doc could do with an update.
 2019-03-11 13:01:42 +01:00
Rémi Verschelde
5b2aaf8d41 Optimize PNGs with optipng 
Using `find -name "*.png" -exec optipng \;` and optipng 0.7.7
 2019-01-26 22:10:03 +01:00
Dirk Krause
7c1f14842d Added Kids Can Code (#2123) 
(cherry picked from commit 785b4d272c)
 2019-01-11 17:23:08 +01:00
Rémi Verschelde
aa7a9f8675 Misc heading fixes 2019-01-08 11:30:55 +01:00
Rémi Verschelde
3b7b77e3fc Update copyright for 2019 
Happy new year to all the documentation contributors!
 2019-01-08 10:13:59 +01:00
Rémi Verschelde
a1af0dfc13 Adapt tutorial hyperlinks after godotengine/godot#24640 2019-01-07 11:43:18 +01:00
Rémi Verschelde
a95cd08285 Use HTTPS for links which support it 2018-12-13 12:06:02 +01:00
Rémi Verschelde
4ef06a4135 Removing trailing whitespace 
With `sed -i $(rg -l '[[:blank:]]*$' -g'!classes') -e 's/[[:blank:]]*$//g'`
 2018-11-20 11:08:34 +01:00
aBARICHELLO
bbe9b5e76e Add Hacktoberfest label to contribution guide 2018-10-09 14:38:41 -03:00
Hugo Locurcio
4741f45ddb Rename all occurrences of Mac OS X to macOS 2018-10-06 14:42:49 +02:00
Rémi Verschelde
3276af7b0d Code style: Add guidelines for header includes 
Fixes #1342.
 2018-09-21 15:35:57 +02:00
Rémi Verschelde
1ba00e422a Style: Upgrade clang-format requirement to 6.x 
See godotengine/godot#20247.
 2018-07-18 17:33:44 +02:00
Yuri Chornoivan
be6ef615b1 Fix minor typos 2018-07-01 15:50:18 +02:00
Swarnim Arun
7c230f051c Adding Steincodes channel link 
to the tutorials page
 2018-06-11 23:54:03 +05:30
None
f064e4f7a7 Fix 404s, some redirects and some broken links. 2018-05-30 16:49:21 -07:00
Max Hilbrunner
8718b14ab2 Merge pull request #1468 from mhilbrunner/docs-translation 
Docs Guide: Translation info
 2018-05-25 17:36:30 +02:00
Max Hilbrunner
f215dea6ba Docs Guide: Translation info 2018-05-25 17:35:41 +02:00
Max Hilbrunner
2015ac3575 Ways to contribute: Mention translations, fixes 2018-05-25 17:14:08 +02:00