Skip to content

How to Contribute to Your Docs

What you need

  • GitHub account
  • To be a contributor on the repo. Ask Zeul to make you one if you are not already.

How to contribute

Step 1

Open up this page alt text

Step 2

Click the dot ket on your keyboard alt text

This will open up: alt text

Step 3

Navigate to docs/Teams/your_team_name/index.md alt text

Step 4

Click this button in the top right in order to preview your content:

alt text

Step 5

Add content. Upload images by dragging and dropping image into the editor while holding down the shift key. Write text and format it using this guide.

Step 6

Commit your changed by clicking this on the left:

alt text

This will show up:

alt text

Enter a commit message using this grammer:

  • Start with an imperative present active verb: Add, Drop, Fix, Refactor, Optimize, etc.
  • Use up to 50 characters.
  • Finish without a period.

Examples - Add foo - Drop foo - Fix foo - Refactor foo - Optimize foo

Enter your message and click the green "Commit & Push button

alt text

Your changes will be live on the website after 40 seconds. Shift-reload the page to see the changes.

Important Tips

  • If it says this: alt text most of the time you should click continue.

  • Click this button alt text in the bottom left before making changes