Welcome to Raider's documentation!
==================================

.. note::
   This documentation and the entire Raider framework is still work in
   progress. Many things are not finished, stuff is missing, other stuff
   is not working as expected, and so on...  Meanwhile, `read the source
   code <https://github.com/OWASP/raider>`_ to understand better how
   Raider works, `open Github issues
   <https://github.com/OWASP/raider/issues>`_ if you find some
   mistakes, or come `talk to us in the Github Discussions
   <https://github.com/OWASP/raider/discussions>`_.




.. toctree::
   :maxdepth: 1
   :caption: Overview

   overview/raider
   overview/install
   overview/glossary
   overview/faq

.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/prerequisites
   tutorials/getting_started
   tutorials/reddit
   tutorials/keycloak
   tutorials/juiceshop

.. toctree::
   :maxdepth: 1
   :caption: Examples

   examples/writing_custom_operations
   examples/writing_custom_plugins
   examples/writing_macros

.. toctree::
   :maxdepth: 1
   :caption: Case Studies

   case_studies/architecture
   case_studies/lisp
   case_studies/macros

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   api/cli
   api/user
   api/macros
   api/internal


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
