.. ghascompliance documentation master file, created by
   sphinx-quickstart on Fri Nov 26 17:06:02 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GHAS Compliance!
==========================================

GitHub Advanced Security Compliance is a Policy as Code Engine and GitHub Action written in Python.
This tool was designed to allow users to specify and configure a Users, Repository, or Organisation's risk tolerance.

Upon finding that a repository has reached the limit and passed the threshold that is unacceptable which is defined as a policy.
Resulting in a number of different out comes but typically breaking the workflows the Action is residing in.


User's Guide
==================

.. toctree::
   :maxdepth: 2

   introduction/index
   policies/index
   samples/index
   api-reference/index