.. ushman.dev documentation master file, created by
   sphinx-quickstart on Fri Sep 25 08:35:50 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


Welcome to the ushman.dev documentation
=======================================
Welcome to the technical documentation for the ushman.dev portfolio website. This documention is intended for developers working on the backend structure of the application including the code, databases, and integrations. 

This application is written in Python using the `Django <https://www.djangoproject.com/>`_ web framework. `Wagtail CMS <https://docs.wagtail.org/en/stable/>`_ provides a `GUI <../../admin>`_ for content managers to work with content. `The philosophy behind this approach can be found here. <https://docs.wagtail.org/en/stable/getting_started/the_zen_of_wagtail.html>`_ 

About This Documentation
------------------------

The technical documentation for this portfolio is intentionally public. It provides an example of the documentation I maintain alongside the
applications I build; documentation for other projects is not publicly available.

These pages describe the site's architecture, development and deployment workflows, operations, and significant technical decisions. Operational
details that are not useful to a public audience - including credentials, infrastructure identifiers, administrative endpoints, and other
environment-specific information - are intentionally excluded.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   overview
   architecture
   development
   deployment
   operations
   decisions


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

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