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: README.md
-88
Original file line number
Diff line number
Diff line change
@@ -42,94 +42,6 @@ If you found a mistake in the content you need to locate the corresponding file
42
42
43
43
## Adding Content
44
44
45
-
### Create a New Datasheet
46
-
47
-
- Create a new feature branch for the datasheet using a `datasheets` prefix. E.g. `datasheets/mkr-1010`
48
-
- You can collaborate with other people on the same branch. For larger changes in a multi-people collaboration setting you can create a separate branch that is based on the feature branch. e.g. `datasheets/mkr-1010-certification` based on `datasheets/mkr-1010`.
49
-
- Inside the product directory e.g. `content/hardware/01.mkr/boards/mkr-wifi-1010` create a folder named `datasheet` for the new datasheet
50
-
- In your newly created folder create the `datasheet.md` file that will contain the content of the datasheet.
51
-
- Create a subfolder called `assets` where you put all the images that are used in the datasheet.
52
-
- Images that purely consist of illustrations should be in SVG format binary images in PNG format. **Make sure to outline the text for SVG exports**. Both Figma and Illustrator provide this option in their file export settings.
53
-
- When you're done with a section of the datasheet that was worked on in a specific branch e.g. `datasheets/mkr-1010-certification` create a Pull Request to merge that branch back into the original feature branch e.g. `datasheets/mkr-1010-certification` -> `datasheets/mkr-1010`. Request a review from the responsible person for this datasheet creation task or additional people from whome you need confirmation on correctness (e.g. from the hardware/firmware team).
54
-
- When you're done with the complete datasheet and you want to merge it back into main, create a pull request e.g. `datasheets/mkr-1010` -> `main`. The build process will create a PDF from the datasheet that will be deployed automatically to the website. ⚠️ This will only work if the branch name contains `datasheet` or `datasheets` in its name, and the PR is not created from a fork.
55
-
Request a review from the responsible person for this datasheet creation task or additional people from whome you need confirmation on correctness (e.g. from the hardware/firmware team).
56
-
- Make sure to preview the datasheet in its rendered form while you're working on it to check for visual glitches. You can do so using the datasheet generator tool.
57
-
58
-
### Linking a Datasheet to a Product
59
-
60
-
If the datasheet is created from markdown and put inside the `datasheet` folder it shows up on the product page automatically. **IMPORTANT:** In order to speed up the preview builds, the datasheets will only be generated if the branch name contains `datasheet` or when the changes are merged back to the `main` branch. You can also set a `url_datasheet` property in the frontmatter part of a product page (product.md) which points to a URL. For the datasheet button in the product page header, the URL will take precedence over the generated datasheet. In the downloads section only the generated datsheets appear.
61
-
62
-
### Adding a new Product Family
63
-
64
-
To add a new family of products, create a new folder under `/content/hardware/`. Please note that the sorting is based on the family name. Therefore, if you need a specific sorting, prepend the name with a number (e.g. 05.nicla).
65
-
Inside that folder create a file named `family.md` and fill in the following contents:
66
-
67
-
```
68
-
---
69
-
title: Family Name
70
-
description: Description of that product family
71
-
---
72
-
```
73
-
74
-
The new family will only show up if it contains at least one product.
75
-
76
-
### Adding a new Product
77
-
78
-
#### Features
79
-
80
-
To add features to a product, a `features.md` file needs to be created in the root folder of a product.
81
-
To list the features the `Feature` tag can be used. The list of features needs to be wrapped inside a `<FeatureList></FeatureList>` tag pair. E.g. `<FeatureList><Feature title="Raspberry Pi RP2040 Microcontroller" image="chip"></FeatureList>`.
The certifications for each product can be added in the frontmatter of a product in the `product.md` (e.g. `certifications: [FCC, CE, RoHS]`) and the PDF can be added to the corresponding product’s `certifications` directory. The naming should be as follows <SKU>_<CERTIFICATION>_<CATEGORY>.pdf e.g. `ABX00023_FCC_DTS.pdf`
126
-
127
-
### Including Code Snippets
128
-
129
-
Code snippets can be included by using the triple backticks syntax e.g. ` ```arduino` followed by the code and three closing backticks. The following syntaxes are supported:
The build system supports symlinks. This allows to include content in multiple places. For example, if there is a tutorial that works for different boards, it can be written once and included in different places. On Unix the `ln` command can be used for that.
0 commit comments