Addon specification template
Prerequisites and information
- Create folder with addon name in corresponding rover folder
- Inside newly created folder
- Create new ProductPreview partial
markdown file. Name should look like this
_addon-name-product.mdx
- Create new
.mdx
file named the same as folder
- Create new ProductPreview partial
markdown file. Name should look like this
- When copying and filling this template, remove all comments
(
{/* comment example */}
). - When copying directly from
.mdx
file, remove all code blocks (only fencing, leave content). - Inline code indicates that this fragment needs to be replaced with other content, such as a React component, description, etc.
Template
Required front matter
---
title:
sidebar_label:
sidebar_position: 1 # addon should have its own folder
keywords: # 4-5
-
description: # max 160 characters
image:
---
Required imports
import Product from './_addon_name-product.mdx'; // use product file that you created as prerequisite
import useBaseUrl from '@docusaurus/useBaseUrl';
import ThemedImageZoom from '@site/src/components/ThemedImageZoom';
import FusionEmbed from '@site/src/components/FusionEmbed';
Addon render, isometric view - ImageZoom
Addon description - About 400 characters
Referenced product
Product Preview - imported _addon_name-product.mdx
Main parameters
Parameter | Value |
---|---|
Dimensions ( LxWxH ) | |
Weight | |
Materials | |
Protection index | |
Operating temperature | |
Operating voltage |
Remove any non-applicable parameters and add any other parameters that are relevant.
Dimensions
Technical drawing with main dimensions, without border - ThemedImageZoom
CAD model
Fusion CAD model preview, with set image before loading - FusionEmbed
3D CAD model in neutral format is also available on our Google Drive:
Link to public Google Drive folder with STEP/STL files
Additional information - REMOVE THIS
Any other information relevant to the particular addon should be included as
replacement of this codeblock.
It includes sections for example:
- safety procedures
- diagrams
- software information
- user interface
- charging procedures
- payload
etc.