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
Copy file name to clipboardExpand all lines: contribution-templates/README.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ We're happy that you have found our contribution page! Here you will find everyt
19
19
6. Iterate according to feedback.
20
20
7. Wait for approval.
21
21
22
-
<hr>
22
+
---
23
23
24
24
# What can I contribute with?
25
25
@@ -37,7 +37,7 @@ You are also allowed to add your own content to the Arduino Documentation reposi
37
37
|-------|-----------|-------|---------|-----|
38
38
|Tutorial|Learn how to do something.|[Control Built-in RGB LED over Wi-Fi with Nano RP2040 Connect](https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-web-server-rgb)|`Tutorials` folder <br> `Tutorial` folder inside the corresponding product|*content > tutorials* <br><br> *content > hardware > 03.nano > boards > nano-33-ble > tutorials*|
39
39
|Article|Learn about a specific topic.|[Multimeter Basics](https://docs.arduino.cc/learn/electronics/multimeter-basics)|`Learn`|*content > learn > 04.electronics*|
40
-
|Nugget|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)|`Tutorials` folder <br> `Tutorial` folder inside the corresponding product <br> `Learn`|*content > tutorials* <br><br> *content > hardware > 03.nano > boards > nano-33-ble > tutorials* <br><br> *content > learn > 04.electronics*|
40
+
|How To|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)|`Tutorials` folder <br> `Tutorial` folder inside the corresponding product <br> `Learn`|*content > tutorials* <br><br> *content > hardware > 03.nano > boards > nano-33-ble > tutorials* <br><br> *content > learn > 04.electronics*|
41
41
|Project|Learn how to build something.|[DIY Photoshop Editing Console using Arduino Nano RP2040 Connect](https://create.arduino.cc/projecthub/jithinsanal1610/diy-photoshop-editing-console-using-arduino-nano-rp-2040-a43e97?ref=search&ref_id=nano%20rp2040%20connect&offset=0)|`Project Hub`*|---|
42
42
43
43
\*Note that the contributed Projects should be added to **Project Hub** instead of on the Arduino Documentation website.
@@ -48,7 +48,7 @@ For us to be able to approve your contribution, you should follow the guidelines
48
48
49
49
Please read the [Arduino Style Guide](https://docs.arduino.cc/hacking/software/ArduinoStyleGuide).
50
50
51
-
<hr>
51
+
---
52
52
53
53
# Documentation Style Guidelines
54
54
@@ -72,16 +72,16 @@ You should use the following markdown styling for our content:
72
72
73
73
***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
74
75
-
<hr>
75
+
---
76
76
77
-
## Graphics
77
+
<!--## Graphics
78
78
79
79
All graphics should be **1920x1080**. All graphics are stored in an assets folder in the documentation folder. See section **Naming Guidelines**.
80
80
81
81
|Type|Purpose|Guidelines|Example|
82
82
|----|-------|----------|-------|
83
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>|
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>|-->
To write a nugget for the Arduino Documentation website, you should follow these guidelines:
1
+
To write a How To for the Arduino Documentation website, you should follow these guidelines:
2
2
3
3
# Structure
4
4
5
5
|Section|Rules|Description|Example|
6
6
|-------|-----|-----------|-------|
7
-
|**Frontmatter**|You must fill in title, description and author. The others are voluntary.|Here is where you add the metadata of your nugget. This is including the author, title of nugget, 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.||
8
-
|**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 nugget.||
9
-
|**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 nugget. You are more than welcome to link the Arduino based software and hardware to the respective store or downloads page.||
10
-
|**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 nugget.||
11
-
|**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 nugget.||
7
+
|**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.||
8
+
|**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.||
9
+
|**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.||
10
+
|**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.||
11
+
|**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.||
12
12
|**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.||
13
-
|**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 nugget.||
13
+
|**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.||
0 commit comments