Skip to main content

Module agents_md

Module agents_md 

Source
Expand description

Project knowledge → a section of AGENTS.md (K1 export).

The section lives between two markers, so an export replaces exactly its own earlier output and nothing the people of the project wrote around it. It lists the current, public facts of the categories an agent acts on — conventions, procedures, decisions, architecture, gotchas, dead ends and experiences — one bullet per fact, under one heading per category. The headings are the ones core::import::markdown maps back to these categories, so importing an export yields the same (category, value) pairs (round trip, tested).

Only Public facts that are not machine-derived are written: the file is committed and leaves the machine with the repository.

Constants§

BEGIN
Opening marker of the generated section.
END
Closing marker of the generated section.
SECTIONS
The categories written, their heading, and the category names a fact may carry for each (singular and plural forms).

Functions§

merge_into
existing with its generated section replaced by section, or with section appended (after one blank line) when it has none yet.
render
The generated section, markers included; empty sections are left out.
render_with_hive
render, with include_hive also a clearly marked section of the team’s knowledge pulled from Hive. AGENTS.md instructs agents, and other members’ text is data (X5) everywhere else; only a person’s explicit export (--include-hive, owner decision 22.10.) republishes it, and only reviewed knowledge: pull loads the delivered head revision (merged, released from quarantine), a swarm never reaches the store, and a fact under review (to verify, contradicted) is left out.