{: .no_toc }

Relativity Trace Documentation is open source, meaning anyone can contribute updates to improve the content. {: .fs-6 .fw-300 }

1. TOC {:toc}

This documentation process was inspired by: Microsoft Docs contributor guide and is based on Markdown language which is lightweight and portable. See more info here.

1. Setup GitHub
2. Create a Pull Request (PR)

   Please make all enhancements in the "develop" branch. {: .info }

3. Use GitHub UI (for Quick Edits) OR https://typora.io for more involved changes
4. Submit changes for review and get PR approved

Follow this guide: https://docs.microsoft.com/en-us/contribute/#quick-edits-to-existing-documents

1. Download https://typora.io
2. Open it and then File -> Preferences
3. Update Image Settings according to below
   1. 
4. ^ this will allow for copying and pasting of images directly into Typora

If these standard principles are not met the project will not build successfully. {: .warn }

Image links MUST reference relative media folder AND images must be placed in the folder named after the name of .MD file within relative media folder

1. Example mardown:

   ![](media/dynamic_rules/RuleGeneratorLayout.PNG)

2. 
3. 
4. 

All links MUST be either relative OR refernce root

1. example:

   {% raw %}
       ---
       ---
       [Extensible API's]({{ site.baseurl }}{% link docs/administrator_guide/proactive_ingestion_api_documentation.md %})
   {% endraw %}

Callouts such as warn, info, etc...

Usage (.info, .warn, .danger are currently supported):

Do not blah blah blah...
{: .warn }

Information {: .info }

Warning {: .warn }

Danger {: .danger }