What's this repository?

Here you will be able to find standard configs, files, starters, links and everything that's awesome. This follows the Awesome Manifesto.

Research if the stuff you're including is actually awesome. Only put stuff on the list that you or another contributor can personally recommend. You should rather leave stuff out than include too much.

This documentation is published on Gitlab Pages click here to access.

Where to start?

If it's your first time here, here are some good links you could start reading:

How to Contribute?

As Contributor

Feel free to create a Merge Request in order add any documentation, code sample, library or anything you consider is relevant.

This repo is a collaborative effort so we all should try to create new content and review other's contributions.

Adding new content

  • The main folder is docs where all the pages should be placed.
  • There is a folder for each section that will be included in the main navbar. It has a XX_ numeric prefix to help with items sorting. Within each main section there is a .pages file to fix the title.
  • Pages within a section can be arranged using the .pages file as well. Refer to Mkdocs Awesome Pages Plugin for more info.
  • Folders can be nested. Them will be added as sub-menu items in the navbar.
  • Please link non-markdown files using Gitlab's url instead of relative paths as Mkdocs will not render a page for it.

Guidelines

  • Try to be clear and precise to make information easy to read.
  • If you are going to add code snippets, please try using Codesandbox or Repl.it so people can play around with your examples.
  • Do not add any new main section unless is extremely necessary as it might affect how docs are rendered
  • Please do your best to write the docs in English. if you need help to do so, please ask for it. If you can't write it in english, it's fine, someone else will translate it later.

As reviewer

  • Anyone from Atix Team can read, review and propose changes.
  • Please make sure the before mentioned Guidelines are being followed.

Deployment

All the code merged to master will be automatically deployed and can be accessed through the Gitlab's page URL.