Files
ConfigKit/docs/internal/overview.md

1.5 KiB

Internal Component Overview

ConfigKit currently contains the root configkit package, which establishes the module and package documentation boundary. Its implemented public primitives are:

  • immutable semantic Path construction and strict JSON Pointer parsing;
  • detached provenance and diagnostic record types with empty Metadata queries;
  • canonical, control-safe diagnostic rendering and structured LoadError access;
  • opaque file, byte, reader, and no-input source construction and bounded reads;
  • a parser-independent ordered tree in internal/document; and
  • the sole upstream YAML integration in internal/yaml, which translates validated input into that owned tree and exposes no parser types outside its boundary.

The configuration input contract owns implemented source and YAML behavior. ConfigKit intentionally exposes no typed loading or decoding API yet. Private metadata population will be integrated when that lifecycle exists.

The source-extraction inventory records the application foundations assigned to future implementation work:

This document will inventory additional components and link to their current contracts and focused internal documentation as they are introduced.

The architecture policy owns binding boundaries and invariants. The initial target design describes planned behavior; it is not an inventory of implemented features. See the development guide for contributor orientation and validation.