.. note-c documentation master file, created by
   sphinx-quickstart on Fri Oct 27 12:49:18 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

note-c
======

note-c is the official C library for communicating with a `Blues Notecard <https://blues.com/products/notecard/>`_. The source code is open source and `available on GitHub <https://github.com/blues/note-c>`_ under the MIT license.

Architecture
------------

Use the :doc:`architecture overview <architecture>` to understand note-c's
module boundaries, public contracts, runtime flow, and update triggers. The
overview links to the `interactive architecture map`_. Structured source-backed
dependency and claim evidence lives in the repository's ``source-research/``
artifacts.

.. _interactive architecture map: architecture/architecture.html

.. toctree::
   :maxdepth: 1

   getting_started
   library_initialization
   calling_the_notecard_api
   ports
   api_reference
   architecture