You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -27,7 +27,7 @@ We're happy that you have found our contribution page! Here you will find everyt
27
27
28
28
The main thing you can contribute with on the Arduino Documentation repository, is the fixing of bugs, misspelling and other similar but small issues.
29
29
30
-
***You are allowed to suggest these changes on all content available on the repository.***
30
+
***You are allowed to suggest these changes on all content available in this repository.***
31
31
32
32
## Adding your own content
33
33
@@ -52,6 +52,50 @@ Please read the [Arduino Style Guide](https://docs.arduino.cc/hacking/software/A
52
52
53
53
# Documentation Style Guidelines
54
54
55
+
## Format Guidelines
56
+
57
+
### Tutorial Guidelines
58
+
59
+
To write a tutorial for the Arduino Documentation website, you should follow these guidelines:
60
+
61
+
|Section|Rules|Description|Example|
62
+
|-------|-----|-----------|-------|
63
+
|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your tutorial. This is including the author, title of tutorial, compatible libraries, compatible hardware etc.||
64
+
|**Introduction**|This is an h2 heading. <br><br> You should not change the name of the heading.|The Introduction to the tutorial should be a maximum of three sentences long and be well descriptive of what the reader can expect of the tutorial.||
65
+
|**Goals**|This is an h2 heading. <br><br> You should not change the name of the heading.|What are the goals of this tutorial? What should the reader be able to do at the end?||
66
+
|**Hardware & Software Needed**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you set the hardware and software you need to continue your tutorial. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.||
67
+
|**Circuit/Schematic**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.||
68
+
|**Focus Feature**|This is an h2 heading. <br><br> Here you are allowed to use as many h3 headings as you want, to be able to divide your content into easier to read sections. <br><br> You can add up to three Focus Feature headings in your tutorial. <br><br> This is the only heading you are allowed to modify.|This sections heading should be updated to the main focus of your tutorial. This is where the information about the focus start.||
69
+
|**Programming the Board**|This is an h2 heading. <br><br> You should not change the name of the heading.|This is the section where you go through the code of your tutorial. ||
70
+
|**Testing it Out**|This is an h2 heading. <br><br> You should not change the name of the heading.|This is the experimental part of your tutorial, where the reader is supposed to test out the code and focus of your tutorial.||
71
+
|**Troubleshoot**|This is an h3 heading. <br><br> You should not change the name of the heading.|If there are something in your tutorial that you know people might get stuck on, or get wrong, this is the section where you give suggestion on how the reader can troubleshoot.||
72
+
|**Conclusion**|This is an h2 heading. <br><br> You should not change the name of the heading.|This is where you summarize your tutorial in a few sentences. What is it that you hoped to have taught or shown the reader?||
73
+
74
+
### How To Guidelines
75
+
76
+
To write a How To for the Arduino Documentation website, you should follow these guidelines:
77
+
78
+
|Section|Rules|Description|Example|
79
+
|-------|-----|-----------|-------|
80
+
|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your How To. This is including the author, title of How To, compatible libraries, compatible hardware etc. <br><br> You must fill in title, description and author. The others are voluntary. **Note** that you must remove the sections in the frontmatter which are empty.||
81
+
|**Introduction**|This is an h2 heading. <br><br> You should not change the name of the heading.|The Introduction to the tutorial should be a maximum of three sentences long and be well descriptive of what the reader can expect of the How To.||
82
+
|**Hardware & Software Needed**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you set the hardware and software you need to continue your How To. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.||
83
+
|**Circuit**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you add the circuit/s and of your How To.||
84
+
|**Schematic**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you add the schematic/s and of your How To.||
85
+
|**Code**|This is an h2 heading. <br><br> You should not change the name of the heading.|This is where you add your sketch code as well as the descriptive text explaining what the code does and is used for.||
86
+
|**Learn more**|This is an h2 heading. <br><br> You should not change the name of the heading.|This is where you link to more information that the reader could be interested in. This could for example be other tutorials that delve deeper into the same topic, or a project that focus on the learnings of this How To.||
87
+
88
+
### Article Guidelines
89
+
90
+
To write a article for the Arduino Documentation website, you should follow these guidelines:
91
+
92
+
|Section|Rules|Description|Example|
93
+
|-------|-----|-----------|-------|
94
+
|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your article. This is including the author, title of tutorial, compatible libraries, compatible hardware etc.||
95
+
|**Introduction**|This is an h2 heading. <br><br> You should not change the name of the heading.|The Introduction should be a maximum of three sentences long and be well descriptive of what the reader can expect of the article.||
96
+
|**Hardware & Software Needed**|This is an h2 heading. <br><br> You can modify the heading if your article only requires one of the two, either Hardware or Software.|Here you set the hardware and software you need to continue your tutorial. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.||
97
+
|**Circuit/Schematic**|This is an h2 heading. <br><br> You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.| <br><br> |
98
+
55
99
## Markdown
56
100
57
101
We write all of our content in markdown. To be able to contribute properly to our website, we suggest you to do the same. Practice your markdown skills here: https://commonmark.org/help/tutorial/
@@ -60,28 +104,79 @@ You should use the following markdown styling for our content:
60
104
61
105
|Style|Use|Description|Example|
62
106
|-----|---|-----------|-------|
63
-
|**Bold**|\*\*bold**|Use bold when you are referring to either a path in the chosen software, or when you want to highlight a specific topic or button.||
64
-
|**Inline Code**|\`code\`|Use the inline code markdown for code inside text sections.||
65
-
|**Code Snippet**|\```arduino <br><br> this is my code <br><br>\```|Use the code snippet markdown for longer code snippets.||
66
-
|**Notes**|\*\*\*Note: This is my note.***|Use the three asterisks for note tags. Note that these can’t contain line-breaks unless made with a \<br> tag.||
107
+
|**Bold**|\*\*bold**|Use bold when you are referring to either a path in the chosen software, or when you want to highlight a specific topic or button.||
108
+
|**Inline Code**|\`code\`|Use the inline code markdown for code inside text sections.||
109
+
|**Code Snippet**|\```arduino <br><br> this is my code <br><br>\```|Use the code snippet markdown for longer code snippets.||
110
+
|**Notes**|\*\*\*Note: This is my note.***|Use the three asterisks for note tags. Note that these can’t contain line-breaks unless made with a \<br> tag.||
67
111
|**Quotes**|\> This is a quote.|Use sparsely and with quotes only.|![Example use of quote tag]()|
68
-
|**Bullet points**|\* bullet point 1 <br>\* bullet point 2 <br>\* bullet point 3|Use the * or the - to make bullet points in your tutorial. <br><br> If your bullet point is a full sentence, remember to punctuate it. If your bullet point is a single word, or words not making a sentence, leave the punctuation off.||
69
-
|**Numbered lists**|\*\*1.** One <br>\*\*2.** Two <br>\*\*3.** Three|Make sure to bold your numbering lists to make them format properly.||
70
-
|**Paths**|This > is > my > path|Use > when describing paths in your chosen software.||
71
-
|**Images**||Use the image tag to display images.||
112
+
|**Bullet points**|\* bullet point 1 <br>\* bullet point 2 <br>\* bullet point 3|Use the * or the - to make bullet points in your tutorial. <br><br> If your bullet point is a full sentence, remember to punctuate it. If your bullet point is a single word, or words not making a sentence, leave the punctuation off.||
113
+
|**Numbered lists**|\*\*1.** One <br>\*\*2.** Two <br>\*\*3.** Three|Make sure to bold your numbering lists to make them format properly.||
114
+
|**Paths**|This > is > my > path|Use > when describing paths in your chosen software.||
115
+
|**Images**||Use the image tag to display images.||
72
116
73
117
***Note that we are not including cursive writing as a markdown style. We implore you not to use cursive as a means to highlight text. Instead use bold.***
74
118
75
-
---
119
+
## Trademark Guidelines
120
+
121
+
If you want to include unit symbols or trademarked names in your content, please follow these guidelines.
122
+
123
+
### Units
124
+
125
+
For all unit symbols, make sure to include a space between the number and the symbol.
76
126
77
-
<!-- ## Graphics
127
+
Wrong: `1.75μm pixel size`
128
+
129
+
Right: `1.75 μm pixel size`
130
+
131
+
|Unit|Symbol|
132
+
|----|------|
133
+
|kilobyte|kB|
134
+
|megabyte|MB|
135
+
|micrometers|μm|
136
+
137
+
***Note that this table will be updated with more examples in the future.***
***Note that this table will be updated with more examples in the future.***
156
+
157
+
### Other
158
+
159
+
These are some other naming structures that we recommend using:
160
+
161
+
* OpenMV
162
+
* MicroPython
163
+
* OTA (Over-the-air)
164
+
* USB-_ (A/B/C)
165
+
166
+
***Note that this list will be updated with more examples in the future.***
167
+
168
+
<!--
169
+
170
+
## Graphics
78
171
79
172
All graphics should be **1920x1080**. All graphics are stored in an assets folder in the documentation folder. See section **Naming Guidelines**.
80
173
81
174
|Type|Purpose|Guidelines|Example|
82
175
|----|-------|----------|-------|
83
-
|Circuit/Schematic|**Circuit diagrams** represent how Arduino products work with components in order to function. <br> A **schematic** is a stylized electronic diagram explaining electric circuits.|Please follow [this]() guide on how to create your own Arduino approved circuit diagrams and schematics.|<br>|
84
-
|Screenshot|**Screenshots** are most often used to show the program in the Arduino IDE or any other chosen software.|Please follow [this]() guide on how to create your own Arduino approved screenshots.|<br><br>| -->
176
+
|Circuit/Schematic|**Circuit diagrams** represent how Arduino products work with components in order to function. <br> A **schematic** is a stylized electronic diagram explaining electric circuits.|Please follow [this]() guide on how to create your own Arduino approved circuit diagrams and schematics.|<br>|
177
+
|Screenshot|**Screenshots** are most often used to show the program in the Arduino IDE or any other chosen software.|Please follow [this]() guide on how to create your own Arduino approved screenshots.|<br><br>|
178
+
179
+
-->
85
180
86
181
## Naming Guidelines
87
182
@@ -93,15 +188,15 @@ Name the folder after the title of your documentation. The name of the folder sh
93
188
94
189
`SoftwareSerialExample`
95
190
96
-
191
+
97
192
98
193
The folder should then contain an assets folder, as well as the main content markdown file. It’s important to name the main content file the same name as the folder.
99
194
100
195
`connector-basics.md`
101
196
102
197
`SoftwareSerialExample.md`
103
198
104
-
199
+
Copy file name to clipboardExpand all lines: contribution-templates/article-template/article-template.md
+25-17Lines changed: 25 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,40 @@ description: 'This is the template for creating an article for the Arduino Docum
4
4
tags:
5
5
- article
6
6
author: 'Arduino'
7
-
libraries:
8
-
- name: Arduino PDM
9
-
url: https://www.arduino.cc/en/Reference/PDM
10
-
hardware:
11
-
- hardware/03.nano/boards/nano-rp2040-connect
12
-
software:
13
-
- ide-v1
14
-
- ide-v2
15
-
- web-editor
16
-
- iot-cloud
17
7
---
18
8
19
-
<!--Update the frontmatter above with information that fits your article. Remove the section that are not relevant or filled in. Note that you must at least fill in the title, description and author.-->
20
-
21
9
## Introduction
22
10
23
-
<!-- Write a short introduction to the article. This should be maximum three sentences long and summarize what the article is about. -->
11
+
Write a short introduction to the article. Consider this to be an abstract that should summarize the content of this article.
12
+
13
+
Note that **plagiarism is unacceptable**, and we encourage you to provide references used to produce your article. These can be listed under the **"References"** section at the bottom of this article. Plagiarised work will be removed immediately.
14
+
15
+
## Hardware & Software Needed (Optional)
24
16
25
-
## Hardware & Software Needed
17
+
***This section is optional, since articles may not directly include the use of an Arduino board or the software.***
26
18
27
-
<!--List the hardware and software needed. This could be the IDEs, libraries but also the hardware such as the board for example. Make sure to link to whatever you are listing. -->
19
+
List the hardware and software needed. This could be the IDEs, libraries but also the hardware such as the board for example. Make sure to link to whatever you are listing.
28
20
29
21
- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
0 commit comments