Skip to content

How to use GitHub to edit the documentation

Short guide

  1. Edit files locally.
  2. Check results using zensical serve.
  3. Commit locally your edits.
  4. Repeat from 1 to 3 until it's finished.
  5. Create new branch with name: "division_name-branch_name"
    (example: Instruments-kinematic_control).
  6. Commit your changes on the new branch.
  7. Once finalized all the changes ask your division leaders to check.
  8. After the check ask team leaders for final check and merge.

Clown

Don't be a clown merging by yourself!

Rules

  • Do not touch any file that doesn't belong to you.
  • Do not CREATE any ".md" file, ask team leaders for creating.
  • Do not DELETE any ".md" file or any file that doesn't belong to you.
  • You are free to upload images (use ".webp" format because it's optimized) or any other file you want to include in the documentation, but only in the "assets" folder of your division.

Memes

If you have to upload memes just ask us, so we upload them on the main assets folder to be reused in every page.

Versioning

Please write good commit comments, so we can know what you just uploaded.
If you don't and just write something like "added clowns" it's a good way to get salsicciato by us.

How do the pages work?

For each subtopic you will find in its folder a folder named paragraphs and a file main.md.
Inside that main.md file you will find references to the .md files inside the paragraphs folder.
DO NOT edit main.md, it will automatically be edited by those who create .md files when you ask.
Each page in paragraph will be linked in the main.md and visualized one after another.

Need help?

If you have troubles, you can contact the maintainer of the documentation (me writing) on Telegram at @riccardo_flames
Since I just studied this things to create all you see here, I'm probably the best person to ask for help.