Skip to content

Commit dc583ee

Browse files
authored
Merge pull request #644 from kylelobo/patch-1
Fix grammatical, formatting errors
2 parents 1bf53be + 56d95da commit dc583ee

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Reference-en is the repo for the Language Reference documentation of the Arduino syntax in **English**.
44
All the Reference terms files are in AsciiDoc format.
55

6-
Thank you for taking the time to contribute to Arduino content, this is really helpful to the whole Arduino Community. If you want to learn more on how to contribute to this project, please check https://create.arduino.cc/projecthub/Arduino_Genuino/contribute-to-the-arduino-reference-af7c37[this step by step tutorial].
6+
Thank you for taking the time to contribute to Arduino content, this is really helpful to the whole Arduino Community. If you want to learn more about how to contribute to this project, please check https://create.arduino.cc/projecthub/Arduino_Genuino/contribute-to-the-arduino-reference-af7c37[this step by step tutorial].
77

88
== Content Creation and Editing
99
If you want to contribute new content, create a new file (with any text or code editor) and save it as .adoc.
@@ -15,12 +15,12 @@ If you want to contribute to the Language Reference or edit existing content, yo
1515
* Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc[`AsciiDoc_Template-Single_Entity.adoc`] (rendered https://www.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-single_entity/[here]) for terms such as link:http://arduino.cc/en/Reference/AnalogWrite[analogWrite].
1616
* Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc[`AsciiDoc_Template-Parent_Of_Entities.adoc`] (rendered https://www.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-parent_of_entities/[here]) for groups of functions such as link:http://arduino.cc/en/Reference/Serial[Serial].
1717

18-
Please note that every Reference file should include at least a Description, some Example Code, and links to other relevant infos (See Also section).
18+
Please note that every Reference file should include at least a Description, some Example Code, and links to other relevant info (See Also section).
1919

2020
If you need to add images to the Asciidoc please create a folder called attachments in the same directory as the Asciidoc file. Images can be saved in SVG and PNG format, max size 200KB.
2121

2222
== Contribute Content on Github
23-
If you are not familiar with Git you can contribute content directly on Github via their online interface. We put together a short Tutorial to show you how, https://create.arduino.cc/projecthub/Arduino_Genuino/contribute-to-the-arduino-reference-af7c37[CHECK IT OUT!]
23+
If you are not familiar with Git you can contribute content directly on Github via their online interface. We put together a short Tutorial to show you how - https://create.arduino.cc/projecthub/Arduino_Genuino/contribute-to-the-arduino-reference-af7c37[CHECK IT OUT!]
2424

2525
link:https://help.github.com/articles/editing-files-in-another-user-s-repository/[You can also follow this guide] (written by the Github team) to learn how to edit an .adoc file and propose a file change to the Arduino team.
2626
When suggesting a change, please follow the guidelines described in the Reference template files.

0 commit comments

Comments
 (0)