diff --git a/contribution-templates/README.md b/contribution-templates/README.md index 165429ee14..a479ddcf52 100644 --- a/contribution-templates/README.md +++ b/contribution-templates/README.md @@ -27,7 +27,7 @@ We're happy that you have found our contribution page! Here you will find everyt The main thing you can contribute with on the Arduino Documentation repository, is the fixing of bugs, misspelling and other similar but small issues. -***You are allowed to suggest these changes on all content available on the repository.*** +***You are allowed to suggest these changes on all content available in this repository.*** ## Adding your own content @@ -60,28 +60,28 @@ You should use the following markdown styling for our content: |Style|Use|Description|Example| |-----|---|-----------|-------| -|**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.|![Example use of bold](assets/bold1.png)| -|**Inline Code**|\`code\`|Use the inline code markdown for code inside text sections.|![Example use of inline code](assets/inline-code.png)| -|**Code Snippet**|\```arduino

this is my code

\```|Use the code snippet markdown for longer code snippets.|![Example use of code snippet](assets/code-snippet.png)| -|**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 \
tag.|![Example use of note tag](assets/notes.png)| +|**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.|![Example use of bold](_assets/bold1.png)| +|**Inline Code**|\`code\`|Use the inline code markdown for code inside text sections.|![Example use of inline code](_assets/inline-code.png)| +|**Code Snippet**|\```arduino

this is my code

\```|Use the code snippet markdown for longer code snippets.|![Example use of code snippet](_assets/code-snippet.png)| +|**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 \
tag.|![Example use of note tag](_assets/notes.png)| |**Quotes**|\> This is a quote.|Use sparsely and with quotes only.|![Example use of quote tag]()| -|**Bullet points**|\* bullet point 1
\* bullet point 2
\* bullet point 3|Use the * or the - to make bullet points in your tutorial.

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.|![Example use of bullet points](assets/bullet-points.png)| -|**Numbered lists**|\*\*1.** One
\*\*2.** Two
\*\*3.** Three|Make sure to bold your numbering lists to make them format properly.|![Example use of numbered lists](assets/numbered-list.png)| -|**Paths**|This > is > my > path|Use > when describing paths in your chosen software.|![Example use of paths](assets/path.png)| -|**Images**|![image alternative text](relative link to image in assets folder)|Use the image tag to display images.|![Example use of images](assets/image-tags.png)| +|**Bullet points**|\* bullet point 1
\* bullet point 2
\* bullet point 3|Use the * or the - to make bullet points in your tutorial.

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.|![Example use of bullet points](_assets/bullet-points.png)| +|**Numbered lists**|\*\*1.** One
\*\*2.** Two
\*\*3.** Three|Make sure to bold your numbering lists to make them format properly.|![Example use of numbered lists](_assets/numbered-list.png)| +|**Paths**|This > is > my > path|Use > when describing paths in your chosen software.|![Example use of paths](_assets/path.png)| +|**Images**|![image alternative text](relative link to image in assets folder)|Use the image tag to display images.|![Example use of images](_assets/image-tags.png)| ***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.*** --- - +|Circuit/Schematic|**Circuit diagrams** represent how Arduino products work with components in order to function.
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.|![Example of circuit](_assets/circuit1.png)
![Example of circuit](_assets/circuit2.png)| +|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.|![Example of screenshot](_assets/screenshot1.png)
![Example of screenshot](_assets/screenshot2.png)
![](_assets/screenshot3.png)| ## Naming Guidelines @@ -93,7 +93,7 @@ Name the folder after the title of your documentation. The name of the folder sh `SoftwareSerialExample` -![Naming of tutorial folder](assets/tutorial-folder.png) +![Naming of tutorial folder](_assets/tutorial-folder.png) 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. @@ -101,7 +101,7 @@ The folder should then contain an assets folder, as well as the main content mar `SoftwareSerialExample.md` -![Naming and formatting of tutorial folder](assets/tutorial-folder2.png) +![Naming and formatting of tutorial folder](_assets/tutorial-folder2.png) ### Images @@ -110,3 +110,50 @@ There is no specific way you need to name the images, however it is a good pract `UNO-Mini-LE-external-power.png` `rp2040-ap-mode-img-01.png` + +## Format Guidelines + +### Tutorial Guidelines + +To write a tutorial for the Arduino Documentation website, you should follow these guidelines: + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**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.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](_assets/tut-intro.png)| +|**Goals**|This is an h2 heading.

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?|![Example of Goals](_assets/tut-goals.png)| +|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](_assets/tut-hardware.png)| +|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](_assets/tut-circuit.png)| +|**Focus Feature**|This is an h2 heading.

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.

You can add up to three Focus Feature headings in your tutorial.

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.|![Example of Focus Feature](_assets/tut-fcus.png)| +|**Programming the Board**|This is an h2 heading.

You should not change the name of the heading.|This is the section where you go through the code of your tutorial. |![Example of Programming the Board](_assets/tut-programming.png)| +|**Testing it Out**|This is an h2 heading.

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.|![Example of Testing it Out](_assets/tut-testing.png)| +|**Troubleshoot**|This is an h3 heading.

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.|![Example of Troubleshoot](_assets/tut-troubleshoot.png)| +|**Conclusion**|This is an h2 heading.

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?|![Example of Conclusion](_assets/tut-conclusion.png)| + +### How To Guidelines + +To write a How To for the Arduino Documentation website, you should follow these guidelines: + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**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.

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.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](_assets/nug-intro.png)| +|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](_assets/nug-hardware.png)| +|**Circuit**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuit/s and of your How To.|![Example of Circuit](_assets/nug-circuit.png)| +|**Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the schematic/s and of your How To.|![Example of Schematic](_assets/nug-schematic.png)| +|**Code**|This is an h2 heading.

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.|![Example of Code](_assets/nug-code.png)| +|**Learn more**|This is an h2 heading.

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.|![Example of Learn more](_assets/nug-learn.png)| + +### Article Guidelines + +To write a article for the Arduino Documentation website, you should follow these guidelines: + +# Structure + +|Section|Rules|Description|Example| +|-------|-----|-----------|-------| +|**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.|![Example of Frontmatter](_assets/frontmatter.png)| +|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](_assets/art-intro.png)| +|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](_assets/hardware.png)| +|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](_assets/art-circuit.png)

![Example of Schematic](_assets/art-schematic.png)| + diff --git a/contribution-templates/article-template/assets/art-circuit.png b/contribution-templates/_assets/art-circuit.png similarity index 100% rename from contribution-templates/article-template/assets/art-circuit.png rename to contribution-templates/_assets/art-circuit.png diff --git a/contribution-templates/article-template/assets/art-intro.png b/contribution-templates/_assets/art-intro.png similarity index 100% rename from contribution-templates/article-template/assets/art-intro.png rename to contribution-templates/_assets/art-intro.png diff --git a/contribution-templates/article-template/assets/art-schematic.png b/contribution-templates/_assets/art-schematic.png similarity index 100% rename from contribution-templates/article-template/assets/art-schematic.png rename to contribution-templates/_assets/art-schematic.png diff --git a/contribution-templates/assets/bold1.png b/contribution-templates/_assets/bold1.png similarity index 100% rename from contribution-templates/assets/bold1.png rename to contribution-templates/_assets/bold1.png diff --git a/contribution-templates/assets/bullet-points.png b/contribution-templates/_assets/bullet-points.png similarity index 100% rename from contribution-templates/assets/bullet-points.png rename to contribution-templates/_assets/bullet-points.png diff --git a/contribution-templates/assets/circuit1.png b/contribution-templates/_assets/circuit1.png similarity index 100% rename from contribution-templates/assets/circuit1.png rename to contribution-templates/_assets/circuit1.png diff --git a/contribution-templates/assets/circuit2.png b/contribution-templates/_assets/circuit2.png similarity index 100% rename from contribution-templates/assets/circuit2.png rename to contribution-templates/_assets/circuit2.png diff --git a/contribution-templates/assets/code-snippet.png b/contribution-templates/_assets/code-snippet.png similarity index 100% rename from contribution-templates/assets/code-snippet.png rename to contribution-templates/_assets/code-snippet.png diff --git a/contribution-templates/article-template/assets/frontmatter.png b/contribution-templates/_assets/frontmatter.png similarity index 100% rename from contribution-templates/article-template/assets/frontmatter.png rename to contribution-templates/_assets/frontmatter.png diff --git a/contribution-templates/article-template/assets/hardware.png b/contribution-templates/_assets/hardware.png similarity index 100% rename from contribution-templates/article-template/assets/hardware.png rename to contribution-templates/_assets/hardware.png diff --git a/contribution-templates/assets/image-tags.png b/contribution-templates/_assets/image-tags.png similarity index 100% rename from contribution-templates/assets/image-tags.png rename to contribution-templates/_assets/image-tags.png diff --git a/contribution-templates/assets/inline-code.png b/contribution-templates/_assets/inline-code.png similarity index 100% rename from contribution-templates/assets/inline-code.png rename to contribution-templates/_assets/inline-code.png diff --git a/contribution-templates/assets/notes.png b/contribution-templates/_assets/notes.png similarity index 100% rename from contribution-templates/assets/notes.png rename to contribution-templates/_assets/notes.png diff --git a/contribution-templates/how-to-template/assets/nug-circuit.png b/contribution-templates/_assets/nug-circuit.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-circuit.png rename to contribution-templates/_assets/nug-circuit.png diff --git a/contribution-templates/how-to-template/assets/nug-code.png b/contribution-templates/_assets/nug-code.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-code.png rename to contribution-templates/_assets/nug-code.png diff --git a/contribution-templates/how-to-template/assets/nug-hardware.png b/contribution-templates/_assets/nug-hardware.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-hardware.png rename to contribution-templates/_assets/nug-hardware.png diff --git a/contribution-templates/how-to-template/assets/nug-intro.png b/contribution-templates/_assets/nug-intro.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-intro.png rename to contribution-templates/_assets/nug-intro.png diff --git a/contribution-templates/how-to-template/assets/nug-learn.png b/contribution-templates/_assets/nug-learn.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-learn.png rename to contribution-templates/_assets/nug-learn.png diff --git a/contribution-templates/how-to-template/assets/nug-schematic.png b/contribution-templates/_assets/nug-schematic.png similarity index 100% rename from contribution-templates/how-to-template/assets/nug-schematic.png rename to contribution-templates/_assets/nug-schematic.png diff --git a/contribution-templates/assets/numbered-list.png b/contribution-templates/_assets/numbered-list.png similarity index 100% rename from contribution-templates/assets/numbered-list.png rename to contribution-templates/_assets/numbered-list.png diff --git a/contribution-templates/assets/path.png b/contribution-templates/_assets/path.png similarity index 100% rename from contribution-templates/assets/path.png rename to contribution-templates/_assets/path.png diff --git a/contribution-templates/assets/screenshot1.png b/contribution-templates/_assets/screenshot1.png similarity index 100% rename from contribution-templates/assets/screenshot1.png rename to contribution-templates/_assets/screenshot1.png diff --git a/contribution-templates/assets/screenshot2.png b/contribution-templates/_assets/screenshot2.png similarity index 100% rename from contribution-templates/assets/screenshot2.png rename to contribution-templates/_assets/screenshot2.png diff --git a/contribution-templates/assets/screenshot3.png b/contribution-templates/_assets/screenshot3.png similarity index 100% rename from contribution-templates/assets/screenshot3.png rename to contribution-templates/_assets/screenshot3.png diff --git a/contribution-templates/tutorial-template/assets/tut-circuit.png b/contribution-templates/_assets/tut-circuit.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-circuit.png rename to contribution-templates/_assets/tut-circuit.png diff --git a/contribution-templates/tutorial-template/assets/tut-conclusion.png b/contribution-templates/_assets/tut-conclusion.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-conclusion.png rename to contribution-templates/_assets/tut-conclusion.png diff --git a/contribution-templates/tutorial-template/assets/tut-fcus.png b/contribution-templates/_assets/tut-fcus.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-fcus.png rename to contribution-templates/_assets/tut-fcus.png diff --git a/contribution-templates/tutorial-template/assets/tut-goals.png b/contribution-templates/_assets/tut-goals.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-goals.png rename to contribution-templates/_assets/tut-goals.png diff --git a/contribution-templates/tutorial-template/assets/tut-hardware.png b/contribution-templates/_assets/tut-hardware.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-hardware.png rename to contribution-templates/_assets/tut-hardware.png diff --git a/contribution-templates/tutorial-template/assets/tut-intro.png b/contribution-templates/_assets/tut-intro.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-intro.png rename to contribution-templates/_assets/tut-intro.png diff --git a/contribution-templates/tutorial-template/assets/tut-programming.png b/contribution-templates/_assets/tut-programming.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-programming.png rename to contribution-templates/_assets/tut-programming.png diff --git a/contribution-templates/tutorial-template/assets/tut-testing.png b/contribution-templates/_assets/tut-testing.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-testing.png rename to contribution-templates/_assets/tut-testing.png diff --git a/contribution-templates/tutorial-template/assets/tut-troubleshoot.png b/contribution-templates/_assets/tut-troubleshoot.png similarity index 100% rename from contribution-templates/tutorial-template/assets/tut-troubleshoot.png rename to contribution-templates/_assets/tut-troubleshoot.png diff --git a/contribution-templates/assets/tutorial-folder.png b/contribution-templates/_assets/tutorial-folder.png similarity index 100% rename from contribution-templates/assets/tutorial-folder.png rename to contribution-templates/_assets/tutorial-folder.png diff --git a/contribution-templates/assets/tutorial-folder2.png b/contribution-templates/_assets/tutorial-folder2.png similarity index 100% rename from contribution-templates/assets/tutorial-folder2.png rename to contribution-templates/_assets/tutorial-folder2.png diff --git a/contribution-templates/article-template/README.md b/contribution-templates/article-template/README.md deleted file mode 100644 index 2aa098413f..0000000000 --- a/contribution-templates/article-template/README.md +++ /dev/null @@ -1,10 +0,0 @@ -To write a article for the Arduino Documentation website, you should follow these guidelines: - -# Structure - -|Section|Rules|Description|Example| -|-------|-----|-----------|-------| -|**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.|![Example of Frontmatter](assets/frontmatter.png)| -|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](assets/art-intro.png)| -|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](assets/hardware.png)| -|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](/_templates/article-template/assets/art-circuit.png)

![Example of Schematic](assets/art-schematic.png)| \ No newline at end of file diff --git a/contribution-templates/article-template/article-template.md b/contribution-templates/article-template/article-template.md index 5370938f63..f9017f3c4b 100644 --- a/contribution-templates/article-template/article-template.md +++ b/contribution-templates/article-template/article-template.md @@ -4,32 +4,40 @@ description: 'This is the template for creating an article for the Arduino Docum tags: - article author: 'Arduino' -libraries: - - name: Arduino PDM - url: https://www.arduino.cc/en/Reference/PDM -hardware: - - hardware/03.nano/boards/nano-rp2040-connect -software: - - ide-v1 - - ide-v2 - - web-editor - - iot-cloud --- - - ## Introduction - +Write a short introduction to the article. Consider this to be an abstract that should summarize the content of this article. + +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. + +## Hardware & Software Needed (Optional) -## Hardware & Software Needed +***This section is optional, since articles may not directly include the use of an Arduino board or the software.*** - +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. - Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)). - [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect). - etc. -## Circuit +## Section 1 + +Free format section. + +## Section 2 + +Free format section. + +## Section 3 + +Free format section. + +## Conclusion + +A summary of your article. + +## References - \ No newline at end of file +- [Arduino (Wikipedia)](https://en.wikipedia.org/wiki/Arduino) \ No newline at end of file diff --git a/contribution-templates/how-to-template/README.md b/contribution-templates/how-to-template/README.md deleted file mode 100644 index ef8e5385cc..0000000000 --- a/contribution-templates/how-to-template/README.md +++ /dev/null @@ -1,13 +0,0 @@ -To write a How To for the Arduino Documentation website, you should follow these guidelines: - -# Structure - -|Section|Rules|Description|Example| -|-------|-----|-----------|-------| -|**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.

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.|![Example of Frontmatter](assets/frontmatter.png)| -|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](assets/nug-intro.png)| -|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](assets/nug-hardware.png)| -|**Circuit**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuit/s and of your How To.|![Example of Circuit](assets/nug-circuit.png)| -|**Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the schematic/s and of your How To.|![Example of Schematic](assets/nug-schematic.png)| -|**Code**|This is an h2 heading.

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.|![Example of Code](assets/nug-code.png)| -|**Learn more**|This is an h2 heading.

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.|![Example of Learn more](assets/nug-learn.png)| \ No newline at end of file diff --git a/contribution-templates/how-to-template/assets/frontmatter.png b/contribution-templates/how-to-template/assets/frontmatter.png deleted file mode 100644 index 04ae45f48a..0000000000 Binary files a/contribution-templates/how-to-template/assets/frontmatter.png and /dev/null differ diff --git a/contribution-templates/how-to-template/how-to-template.md b/contribution-templates/how-to-template/how-to-template.md index dc38f48506..d1079dc219 100644 --- a/contribution-templates/how-to-template/how-to-template.md +++ b/contribution-templates/how-to-template/how-to-template.md @@ -16,15 +16,15 @@ software: - iot-cloud --- - +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. ## Introduction - +Write a short introduction to the How To. This should be maximum three sentences long and summarize what the How To is about. ## Hardware & Software Required - +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. - Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)). - [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect). @@ -32,16 +32,16 @@ software: ## Circuit - +Add the image of the circuit here. This section should not need any text following the image, only a well thought alternative image text. ## Schematic - +Add the image of the schematic here. This section should not need any text following the image, only a well thought alternative image text. ## Code - +Example code for the reader to copy and paste into their own sketch. This section should explain the different sections in the code. ## Learn more - \ No newline at end of file +Information on how the reader could delve deeper into the topic. For example linking to other tutorials or projects. \ No newline at end of file diff --git a/contribution-templates/tutorial-template/README.md b/contribution-templates/tutorial-template/README.md deleted file mode 100644 index a206464b95..0000000000 --- a/contribution-templates/tutorial-template/README.md +++ /dev/null @@ -1,16 +0,0 @@ -To write a tutorial for the Arduino Documentation website, you should follow these guidelines: - -# Structure - -|Section|Rules|Description|Example| -|-------|-----|-----------|-------| -|**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.|![Example of Frontmatter](assets/frontmatter.png)| -|**Introduction**|This is an h2 heading.

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.|![Example of Introduction](assets/tut-intro.png)| -|**Goals**|This is an h2 heading.

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?|![Example of Goals](assets/tut-goals.png)| -|**Hardware & Software Needed**|This is an h2 heading.

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.|![Example of Hardware & Software](assets/tut-hardware.png)| -|**Circuit/Schematic**|This is an h2 heading.

You should not change the name of the heading.|Here you add the circuits and/or schematics of your tutorial.|![Example of Circuit](assets/tut-circuit.png)| -|**Focus Feature**|This is an h2 heading.

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.

You can add up to three Focus Feature headings in your tutorial.

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.|![Example of Focus Feature](assets/tut-fcus.png)| -|**Programming the Board**|This is an h2 heading.

You should not change the name of the heading.|This is the section where you go through the code of your tutorial. |![Example of Programming the Board](assets/tut-programming.png)| -|**Testing it Out**|This is an h2 heading.

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.|![Example of Testing it Out](assets/tut-testing.png)| -|**Troubleshoot**|This is an h3 heading.

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.|![Example of Troubleshoot](assets/tut-troubleshoot.png)| -|**Conclusion**|This is an h2 heading.

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?|![Example of Conclusion](assets/tut-conclusion.png)| \ No newline at end of file diff --git a/contribution-templates/tutorial-template/assets/frontmatter.png b/contribution-templates/tutorial-template/assets/frontmatter.png deleted file mode 100644 index 04ae45f48a..0000000000 Binary files a/contribution-templates/tutorial-template/assets/frontmatter.png and /dev/null differ diff --git a/contribution-templates/tutorial-template/assets/tutorial-folder.png b/contribution-templates/tutorial-template/assets/tutorial-folder.png deleted file mode 100644 index f6a8e2dae9..0000000000 Binary files a/contribution-templates/tutorial-template/assets/tutorial-folder.png and /dev/null differ diff --git a/contribution-templates/tutorial-template/assets/tutorial-folder2.png b/contribution-templates/tutorial-template/assets/tutorial-folder2.png deleted file mode 100644 index c919176fb9..0000000000 Binary files a/contribution-templates/tutorial-template/assets/tutorial-folder2.png and /dev/null differ diff --git a/contribution-templates/tutorial-template/tutorial-template.md b/contribution-templates/tutorial-template/tutorial-template.md index 76c3e63aca..8e2dbf21ea 100644 --- a/contribution-templates/tutorial-template/tutorial-template.md +++ b/contribution-templates/tutorial-template/tutorial-template.md @@ -16,23 +16,23 @@ software: - iot-cloud --- - +Update the frontmatter above with information that fits your tutorial. Remove the section that are not relevant or filled in. Note that you must at least fill in the title, description and author. ## Introduction - +Write a short introduction to the tutorial. This should be maximum three sentences long and summarize what the tutorial is about. ## Goals - +List here the goals of this tutorial. Try to keep it short, approx. 3-5 bullets. -The goals of this project are: +The goals of this tutorial are: - ## Hardware & Software Needed - +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. - Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)). - [Arduino Nano RP2040 Connect](https://store.arduino.cc/nano-rp2040-connect). @@ -40,32 +40,33 @@ The goals of this project are: ## Circuit - +Add the image of the circuit here. This section should not need any text following the image, only a well thought alternative image text. -![](assets/) +![](_assets/) ## Focus Feature - +This is the only heading you should rename to what the feature is about. Talk about the first feature you want this tutorial to highlight. You can use step-by-step instructions, images or code snippets to show examples. You can use subheading h3 here as well. You can also add how many of the "Focus Feature" headings as needed, however as the tutorials only focus on minimal features - this amount should not be higher than three. ## Programming the Board - +Example code for the reader to copy and paste into their own sketch. This section should explain the different sections in the code. ## Testing It Out - +After uploading the code, we should now start using it. Go through the flow with the reader. ### Troubleshoot - +Add a bullet list of the things that could be the potential issue for something not working. If the code is not working, there are some common issues we can troubleshoot: -- +- Troubleshoot point 1 +- Troubleshoot point 2 ## Conclusion - +Add a conclusion to what this tutorial has gone through. Connect back to what you wrote in the "Goals" section.