Skip to main content Link Search Menu Expand Document (external link)

Community Submission Information

The following are guidelines for submitting documentation to the Voron Community documentation repo. This is to provide a consistent format for the resulting documentation and information.

All submissions

All submissions must include the following content in the header of any templated files to be rendered. Any submissions missing this header may be rejected.

---
layout: default
title: <title>
nav_exclude: true
---

Howto Guides, Troubleshooting, Alternate Electronics

Each submitter should create a directory for their user. The directory name should preferably be the same as their Discord username or Github username. Each guide should be named accordingly but include the markdown “.md” extension (e.g. ‘how_to_build_voron.md’). If there are images to be included, it is recommended to create an ‘images’ subdirectory for all of the images and link to those in the guide.

Each pull request should also update the associated base index.md with a link to the guide itself and the creator’s username.

Macros

Each submitter should create a macro file in the ‘macros’ subdirectory.
That file should preferably be the same as their Discord username or Github username.

Each pull request should also update the associated index.md with a link to the macro and the creator’s username.

Pull Requests

How to create Github pull requests