Skip to content

Commit 11e0a18

Browse files
Matteo-itMatteo-it
committed
test 3
1 parent fcee040 commit 11e0a18

File tree

23 files changed

+1354
-48
lines changed

23 files changed

+1354
-48
lines changed

Diff for: ‎_templates/general-article-templates/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
When you are creating a new General Article, this folder will contain the markdown templates you should use.
2+
3+
There are different kinds of articles you can choose from, and this depends on the subject they are focusing on.
4+
5+
All articles have a similar structure however and it looks like this:
6+
7+
*
8+
*

Diff for: ‎_templates/product-page-template/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Creating a new Product Page
2+
3+
When creating a new product page, you should
4+
5+
1. Copy and paste this folder into the correct path.
6+
2. Rename the folder to fit the product you are working on, remember to check the [product list](././../../../scripts/validation/resources/products.yml) for the correct naming.
7+
3. Fill in the information in the different files and folders, make sure that the information in the files match the product that you are working on. There might be some sections that you need to remove because they do not fit the product you are writing about. This includes the information in the tech specs (you get this from the Technical Content Writers) as well as adding the product specific tutorials.
8+
4. Fill in the technical reference file with relevant information. Check out the [Nano RP2040 Connect Technical Reference](/content/hardware/03.nano/boards/nano-rp2040-connect/tutorials/rp2040-01-technical-reference/rp2040-01-technical-reference.md) for inspiration.
9+
10+
## Things to think about:
11+
12+
* add the relevant images in the relevant folders
13+
* name the product with its confirmed name, you can find that here: [product list](././../../../scripts/validation/resources/products.yml). Remember that you don't always have to include the "Arduino" in the beginning of the product name, only the first time you are mentioning it.
14+
15+
**Note:** More information about the product page files and folders can be found in the [main README.md](README.md) file. Such as how to:
16+
17+
* create a new datasheet
18+
* add new products
19+
* add features to product pages
20+
* write code snippets
21+
* reference content from other folders
22+
* use the Content Linter Tool

Diff for: ‎_templates/product-page-template/compatibility.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Update with the appropriate compatible software / boards / shields / carriers
2+
3+
software:
4+
- arduino-ide
5+
- arduino-cli
6+
- iot-cloud
7+
- web-editor
8+

Diff for: ‎_templates/product-page-template/datasheet/datasheet.md

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
---
2+
identifier:
3+
title:
4+
type:
5+
---
6+
7+
![](assets/)
8+
9+
# Description
10+
11+
12+
# Target Areas
13+
14+
15+
# Features
16+
17+
18+
# Contents
19+
20+
## The board
21+
### Application examples
22+
23+
24+
### Accessories
25+
26+
27+
### Related products
28+
- []()
29+
30+
## Ratings
31+
32+
### Recommended operating conditions
33+
| Symbol | Description | Min | Typ | Max | Unit |
34+
| ------ | ----------- | --- | --- | --- | ---- |
35+
| | | | | | |
36+
37+
38+
### Power consumption
39+
| Symbol | Description | Min | Typ | Max | Unit |
40+
| ------ | ----------- | --- | --- | --- | ---- |
41+
| | | | | | |
42+
43+
44+
## Functional overview
45+
### Block Diagram
46+
![](assets/)
47+
48+
### Board Topology
49+
**Front View**
50+
![](assets/)
51+
52+
| **Ref.** | **Description** | **Ref.** | **Description** |
53+
| -------- | --------------- | -------- | --------------- |
54+
| | | | |
55+
56+
57+
**Back View**
58+
![](assets/)
59+
60+
| **Ref.** | **Description** | **Ref.** | **Description** |
61+
| -------- | --------------- | -------- | --------------- |
62+
| | | | |
63+
64+
65+
### Processor
66+
67+
68+
### Wi-Fi/Bluetooth connectivity
69+
70+
71+
### 6-axis IMU
72+
73+
74+
### External memory
75+
76+
77+
### Cryptography
78+
79+
80+
### Microphone
81+
82+
83+
### RGB LED
84+
85+
86+
### Power Tree
87+
![](assets/)
88+
89+
90+
91+
## Board Operation
92+
### Getting started - IDE
93+
94+
### Getting started - Arduino Web Editor
95+
96+
### Getting started - Arduino IoT Cloud
97+
98+
### Sample Sketches
99+
100+
### Online resources
101+
102+
### Board Recovery
103+
104+
## Connector Pinouts
105+
###
106+
| Pin | Function | Type | Description |
107+
| --- | -------- | ---- | ----------- |
108+
| | | | |
109+
110+
111+
###
112+
| Pin | Function | Type | Description |
113+
| --- | -------- | ---- | ----------- |
114+
| | | | |
115+
116+
117+
###
118+
| Pin | Function | Type | Description |
119+
| --- | -------- | ---- | ----------- |
120+
| | | | |
121+
122+
###
123+
| Pin | Function | Type | Description |
124+
| --- | -------- | ---- | ----------- |
125+
| | | | |
126+
127+
128+
###
129+
| Pin | Function | Type | Description |
130+
| --- | -------- | ---- | ----------- |
131+
| | | | |
132+
133+
134+
## Mechanical Information
135+
![](assets/)
136+
137+
## Certifications
138+
### Declaration of Conformity CE DoC (EU)
139+
140+
141+
### Declaration of Conformity to EU RoHS & REACH 211 01/19/2021
142+
143+
144+
| **Substance** | **Maximum Limit (ppm)** |
145+
| ------------- | ----------------------- |
146+
| | |
147+
148+
### Conflict Minerals Declaration
149+
150+
### FCC Caution
151+
152+
## Company information
153+
154+
| Company name | Arduino S.r.l. |
155+
| --------------- | ------------------------------------------------------------- |
156+
| Company Address | Via Ferruccio Pelli 14, 6900 Lugano, TI (Ticino), Switzerland |
157+
158+
## Reference Documentation
159+
160+
| Ref | Link |
161+
| ------------------------------------- | --------------------------------------------------------------------------------------------------- |
162+
| Arduino IDE (Desktop) | https://www.arduino.cc/en/Main/Software |
163+
| Arduino IDE (Cloud) | https://create.arduino.cc/editor |
164+
| Cloud IDE Getting Started | https://create.arduino.cc/projecthub/Arduino_Genuino/getting-started-with-arduino-web-editor-4b3e4a |
165+
| Arduino Website | https://www.arduino.cc/ |
166+
| Project Hub | https://create.arduino.cc/projecthub?by=part&part_id=11332&sort=trending |
167+
| PDM (microphone) Library | https://www.arduino.cc/en/Reference/PDM |
168+
| WiFiNINA (Wi-Fi, W102) Library | https://www.arduino.cc/en/Reference/WiFiNINA |
169+
| ArduinoBLE (Bluetooth, W-102) Library | https://www.arduino.cc/en/Reference/ArduinoBLE |
170+
| IMU Library | https://www.arduino.cc/en/Reference/Arduino_LSM6DS3 |
171+
| Online Store | https://store.arduino.cc/ |
172+
173+
## Revision History
174+
175+
| **Date** | **Revision** | **Changes** |
176+
| -------- | ------------ | ----------- |
177+
| | | |

Diff for: ‎_templates/product-page-template/essentials.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<EssentialsColumn title="First Steps">
2+
<EssentialElement link="/software/ide-v1/installing-mbed-os-nano-boards" title="Quickstart Guide" type="getting-started">
3+
A quick guide to installing your board with the Arduino IDE.
4+
</EssentialElement>
5+
<EssentialElement link="/tutorials/" title="Technical Reference" type="tutorial">
6+
<!-- -->
7+
</EssentialElement>
8+
9+
</EssentialsColumn>
10+
11+
<EssentialsColumn title="Suggested Libraries">
12+
<EssentialElement link="" title="" type="library">
13+
<!-- -->
14+
</EssentialElement>
15+
16+
<EssentialElement link="" title="" type="library" >
17+
<!-- -->
18+
</EssentialElement>
19+
20+
<EssentialElement link="" title="" type="library">
21+
<!-- -->
22+
</EssentialElement>
23+
24+
</EssentialsColumn>
25+
26+
<EssentialsColumn title="Arduino Basics">
27+
<EssentialElement link="https://www.arduino.cc/en/Tutorial/BuiltInExamples" title="Built-in Examples" type="resource">
28+
Built-in Examples are sketches included in the Arduino IDE and demonstrate all basic Arduino commands.
29+
</EssentialElement>
30+
<EssentialElement link="/learn" title="Learn" type="resource">
31+
Discover interesting articles, principles and techniques related to the Arduino ecosystem.
32+
</EssentialElement>
33+
<EssentialElement link="https://www.arduino.cc/reference/en/" title="Language Reference" type="resource">
34+
Arduino programming language can be divided in three main parts: functions, values (variables and constants), and structure.
35+
</EssentialElement>
36+
</EssentialsColumn>

Diff for: ‎_templates/product-page-template/features.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<FeatureDescription>
2+
3+
<!-- -->
4+
5+
</FeatureDescription>
6+
7+
8+
<FeatureList>
9+
<Feature title="" image="mcu">
10+
11+
<!-- -->
12+
13+
<FeatureLink title="Datasheet" url="" download blank/>
14+
</Feature>
15+
16+
<Feature title="" image="core">
17+
18+
<!-- -->
19+
20+
<FeatureLink title="Datasheet" url="" download/>
21+
</Feature>
22+
23+
24+
<Feature title="" image="wifi-bluetooth">
25+
26+
<!-- -->
27+
28+
<FeatureLink title="Datasheet" url="" download blank/>
29+
</Feature>
30+
31+
<Feature title="" image="imu">
32+
33+
<!-- -->
34+
35+
<FeatureLink title="Datasheet" url="" download blank/>
36+
</Feature>
37+
38+
<Feature title="" image="microphone">
39+
40+
<!-- -->
41+
42+
<FeatureLink title="Datasheet" url="" download blank/>
43+
</Feature>
44+
45+
<Feature title="" image="crypto-chip">
46+
47+
<!-- -->
48+
49+
<FeatureLink title="Datasheet" url="" download blank/>
50+
</Feature>
51+
52+
<Feature title="" image="power">
53+
54+
<!-- -->
55+
56+
<FeatureLink title="Datasheet" url="" download blank/>
57+
</Feature>
58+
59+
<Feature title="" image="nano-form-factor">
60+
61+
<!-- -->
62+
63+
</Feature>
64+
65+
</FeatureList>

0 commit comments

Comments
 (0)