Steps to start documenting the equipment/design you found and chose

See this documentation example. You can also download it to see the final result.

1. Getting started

Use this template and guidelines to make your documentation more FAIR (Findable Accessible Interoperable and Reusable). The template has a simple structure that allows to easily present your content separating the source files(src) that users need to replicate from explanations (docs), and guides that explain how to use the source files.

• Download or clone this template to start documenting easily.
• Replace the content in this README.md file with content that describes the key features of your project. Consider it the entry point for the users of your content.

2. Create your design content

• Fill in the source files like STLS, CAD, etc inside the ./src folder.
• Inside ./docs/img/ put images that describe visually your hardware design.
• Describe in markdown inside .docs/ how the content in the ./src folder should be used. This is where you provide some context and description on how to replicate and use your design.
• Inside ./docs/LANGUAGE-CHOSEN write down a simple README in your language of choice, for example ./docs/NL.
• Write down steps to replicate if necessesary as well as guides in sequence.

If this part becomes difficult ask for help here in the #how-to-document-designs channel .

• Fill in the fields in the metadata.yaml file at the root of this folder.
• Describe more extensively your project in metadataExtended.yaml.
• Replace the summary.jpg image with the one that shows your design using the same name.

3. Upload your repository

• If you don't know how to do it we can help you.
• Upload your repository to CombatCovid org, alternatively upload it in your private repo and let us know so that we can fork it and put it in list.

Translating content

If you want to translate the content in the docs folder for instance to Russian or French, a simple way to do it is to first open the new folder inside docs for instance docs/FR, and put the texts in google translate, to then refine and correct the translation.

Advanced steps that we can help with

• Create automatically EPUBs, and PDFs from markdown files.

Pasos para comenzar a documentar el equipo / diseño que encontró y eligió

Vea este ejemplo de documentación También puedes descargarlo para ver el resultado final.

1. Comenzando

Use esta plantilla y pautas para hacer que su documentación sea MÁS JUSTA (interoperable, accesible y reutilizable). La plantilla tiene una estructura simple que permite presentar fácilmente su contenido separando los archivos fuente (src) que los usuarios necesitan replicar de las explicaciones (documentos) y guías que explican cómo usar los archivos fuente.

• Descargue o clone esta plantilla para comenzar a documentar fácilmente.
• Reemplace el contenido de este archivo README.md con contenido que describa las características clave de su proyecto. Considérelo el punto de entrada para los usuarios de su contenido.

2. Crea tu contenido de diseño

• Complete los archivos de origen como STLS, CAD, etc. dentro de la carpeta . / Src.
• Dentro de . / Docs / img / coloque imágenes que describan visualmente su diseño de hardware.
• Describa en markdown dentro de .docs / cómo se debe usar el contenido en la carpeta . / Src. Aquí es donde proporciona un contexto y una descripción sobre cómo replicar y usar su diseño.
• Dentro de . / Docs / LANGUAGE-CHOSEN escriba un LÉAME simple en el idioma que elija, por ejemplo. / Docs / NL.
• Escriba los pasos para replicar si es necesario, así como las guías en secuencia.

Si esta parte se vuelve difícil, solicite ayuda aquí en el canal # how-to-document-designs.

• Complete los campos en el archivo metadata.yaml en la raíz de esta carpeta.
• Describa más ampliamente su proyecto en metadataExtended.yaml.
• Reemplace la imagen summary.jpg con la que muestra su diseño con el mismo nombre.

3. Sube tu repositorio

• Si no sabes cómo hacerlo, podemos ayudarte.
• Cargue su repositorio en la organización CombatCovid, alternativamente cárguelo en su repositorio privado y háganos saber para que podamos bifurcarlo y ponerlo en la lista.

Traduciendo contenido

Si desea traducir el contenido de la carpeta docs, por ejemplo, al ruso o al francés, una forma sencilla de hacerlo es abrir primero la nueva carpeta dentro dedocs, por ejemplo, docs / FR, y poner los textos en traductor de google, para luego refinar y corregir la traducción.

Pasos avanzados con los que podemos ayudar

• Cree automáticamente EPUB y PDF a partir de archivos de descuento.