sheepandshepherd
b23c40b776
Document member and signal link BBCode tags
...
Also replace the method tag example. It was using a method that has been renamed.
2017-10-22 18:53:33 -05:00
Rémi Verschelde
19814da59d
Merge pull request #515 from GDquest/writing-guidelines
...
Add Oxford comma to the writing guidelines
2017-10-14 15:48:46 +02:00
Rémi Verschelde
20c4c3a5c9
Fix various Sphinx warnings
2017-10-14 15:46:14 +02:00
Rémi Verschelde
7f819ed873
Move images to subfolders next to each doc page
2017-10-14 14:41:44 +02:00
Nathan
ba627f249e
Add Oxford comma to the writing guidelines
2017-10-12 15:17:39 +02:00
Andreas Haas
2b58f86b89
Fix doctool command and references to classes.xml
2017-10-11 20:11:52 +02:00
Dario Bonfanti
e6dd84e91c
Fixed some typos + corrections
...
Fixed some typos inside various pages
- Cameara -> Camera
- enclined -> inclined (obsolete form)
- Occulus -> Oculus
- correspondance -> correspondence
- resizeable -> resizable (more used form)
2017-10-08 18:45:15 +02:00
Benjamin Larsson
87a2ded239
Fix missing examples and remove broken highlighting in docs guidelines.
...
Also use [code][/code] for variables etc. in examples, and list the "8 banned words" in the summary.
2017-10-07 13:29:32 +02:00
Nathan Lovato
58e0a8fd21
Writing guidelines: Change title and make img path absolute
...
Remove "Godot" from the title as it's redundant and it shows up in the TOC
Fix img not found: make img path absolute
2017-09-20 08:56:58 +02:00
mhilbrunner
30bab90e1f
Update ways_to_contribute.rst
...
Small style changes, typos, add "hardware information" to section about things to include in bug reports
2017-09-19 18:54:18 +02:00
Rémi Verschelde
ebc4d45956
Merge pull request #475 from GDquest/docs-writing-guidelines
...
add docs writing guidelines
2017-09-19 09:02:23 +02:00
Nathan
cfcdf27740
add docs writing guidelines
...
- add page to the toctree
- add RST formatting and blocks
- add pic to the img/ folder
- add convention to style arguments in class reference, like [code]this[/code]
2017-09-19 08:57:56 +02:00
Nathan
3a2a243f33
update the contribution guide for the new split XML format
...
- add read-the-docs note and warning blocks
- warn people they shouldn't write using the GitHub editor
2017-09-15 14:59:24 +02:00
Chris Bradfield
fe133c09af
Update references to classes.xml -> /doc/classes/*.xml
2017-09-12 23:03:23 -07:00
Poommetee Ketson
b2d5d0b20a
Fix build warnings
2017-09-12 20:07:45 +07:00
Nathan Lovato
9cb30a854c
Proof and rewrite the class ref contribution guide
...
- edit to better fit the new writing guidelines: Shorten sentences, remove passive voice, etc
- shorten XML example
- add video guide
- detail git workflow
- add a 5 points bullet list to reflect the steps to contribute to the class reference
2017-09-11 09:45:52 +02:00
Timo
10f5eff1d3
fixed italic tag
2017-08-08 18:42:47 +02:00
Rémi Verschelde
109adb657f
Contributing: Add docs about code style and clang-format
2017-07-13 17:18:49 +02:00
Rémi Verschelde
f24e9803cd
Contributing: improve bugsquad and docs guidelines
2017-05-14 15:42:40 +02:00
Rémi Verschelde
fde71a5071
Fix links in PR workflow doc
2017-05-07 22:59:23 +02:00
Rémi Verschelde
84538955e0
Add contributing docs on the PR workflow
2017-05-07 22:13:23 +02:00
Rémi Verschelde
1a0d57824d
Add page about the different ways to contribute
2017-05-04 23:44:24 +02:00
Rémi Verschelde
cc666860a8
Fix typos using codespell
...
Running `find -name "*.rst" -exec codespell -w {} \;`.
2017-04-23 14:32:37 +02:00
Rémi Verschelde
fcbab02811
Add toctrees for new repo organization
...
Also renamed Getting started back to Step by step as requested by reduz.
2017-04-03 23:41:35 +02:00
Julian Murgia
b408bdb918
Revamping of the docs organisation for a more coherent TOC
...
Only the pages were moved so far and some empty ones created,
the up-to-date toctrees come in the next commit.
2017-04-03 23:23:31 +02:00
