AI & Project Context Reference

This section contains deep context documentation for both generic standards (UI/coding conventions) and project-specific feature architecture and subsystems for OCI Policy Analysis.

Use these docs for onboarding, design reviews, and as canonical references for internal contracts, extension points, and major architectural decisions.

Organization

There are two types of context documentation included here:

  • Generic Context

  • Project-specific Context

The “Generic Context” files are meant to be reusable across projects and contain general best practices, while the “Project-specific Context” files contain detailed information about the design and architecture of specific features and components of OCI Policy Analysis.

COntext files are generally written by AI and corrected by humnas, but they may contain details that don’t exist yet in the codebase, but are planned for the future. They are living documents that will evolve as the project evolves, and should be updated as needed to reflect changes in the codebase and architecture.

Naming Convention for Context File Titles

To ensure consistent indexing throughout the Sphinx documentation:

  • Project files should start with:

    # Context: <Short Feature or Area Title>
(e.g., "Context: Policy Intelligence and Recommendations")

  • Generic files should start with:

    # Generic <Subject or Convention>
(e.g., "Generic Coding Standards")

The first heading of each file will appear as its title in the documentation navigation/sidebar.

Generic Context

Project-specific Context