Skip to content

Theta

About Theta — what Theta is, the tools it ships, an overview of the architecture, and how to cite it. (Mirrored from the repository's front page.)

How this wiki is organised

Each page is named after the file it comes from, and says at the top which file that is.

  • Modules — documentation living inside the subprojects. A module can have up to three pages:

    Page Mirrors What it is
    README.md subprojects/<family>/<module>/README.md what the module is; conceptual documentation
    USING.md .../USING.md how to use the module's API from elsewhere
    AGENTS.md .../AGENTS.md how to modify the module: invariants, conventions, change recipes

    Larger modules may also carry AGENTS.md files deeper inside (e.g. common/core/type/); those appear nested under the module, mirroring their location in the source tree.

  • Guides — project-wide documentation, mirrored from doc/: building, coding conventions, CI, CEGAR configuration.

About the USING.md and AGENTS.md pages

These two are code-facing: largely derived from the source (and verified against it) rather than written as prose. They are aimed at both contributors and at AI coding assistants, which load AGENTS.md automatically when editing a module. They are deliberately terse and uneven in coverage. README.md pages are ordinary, hand-written documentation.

Contributing

Documentation lives next to the code it describes: add a README.md, USING.md, or AGENTS.md to a subproject and it appears here automatically. See Contributing for the details and for how to preview the wiki locally.