Skip to content

Wiki contribution guide

barbarjan edited this page Aug 16, 2025 · 2 revisions

Markdown

The wiki uses GitHub flavored markdown. To edit you can use the GitHub web editor or clone the wiki locally and edit it in any editor you wish.

Unfortunately it is not possible to make PRs to the wiki so please DM any changes to V Electronics on Discord.

Here is a basic markdown syntax guide.

Editing guidelines

  1. Before making changes open an issue explaining what you wish to change and why.
  2. Use English and make sure your writing is 100% grammatically correct.
  3. Avoid buzzwords, complicated explanations, very long sentences, unnecessary complexity, rants etc.
  4. Avoid massive images over 2MB.
  5. The text should be structured into headings to improve readability.
Clone this wiki locally