Skip to content

AGENTS.md

Latest commit

 

History

History
121 lines (91 loc) · 5.9 KB

AGENTS.md

File metadata and controls

121 lines (91 loc) · 5.9 KB
Raw

dendritic — DOX rail

dendritic-pattern master flake for NIXPC (x86_64-linux, MangoWM) and ASAHI (aarch64-linux, Niri). Every modules/**/*.nix is a flake-parts module auto-registered by import-tree; flake.nix re-exports nixosConfigurations, overlays, packages, and checks.

Project-wide contracts: dendritic pattern (modules/ auto-registration, /_ exclusion, flake.nixosModules/flake.homeManagerModules as values), --impure required for deploy (hardwareFromMachine reads /etc/nixos/hardware-configuration.nix), dual-homed nixConfig caches (flake.nix + modules/system/core/nix-settings.nix stay in sync; an input whose packages upstream publishes to a cache MUST NOT follow nixpkgs), one color source (self.scheme from modules/features/scheme; themed features read it and never hardcode a hex), nixfmt (RFC style) formatting.

Verification ladder (cheapest first): nix-instantiate --parse <file> → nix eval .#nixosConfigurations.<HOST>.config.<option> --impure → nix run .#verify / nix flake check --impure (parse, eval-pure, hardware, fmt, aggregate gates from modules/verify.nix).

DOX framework

  • DOX is highly performant AGENTS.md hierarchy installed here
  • Agent must follow DOX instructions across any edits

Core Contract

  • AGENTS.md files are binding work contracts for their subtrees
  • Work products, source materials, instructions, records, assets, and durable docs must stay understandable from the nearest applicable AGENTS.md plus every parent AGENTS.md above it

Read Before Editing

  1. Read the root AGENTS.md
  2. Identify every file or folder you expect to touch
  3. Walk from the repository root to each target path
  4. Read every AGENTS.md found along each route
  5. If a parent AGENTS.md lists a child AGENTS.md whose scope contains the path, read that child and continue from there
  6. Use the nearest AGENTS.md as the local contract and parent docs for repo-wide rules
  7. If docs conflict, the closer doc controls local work details, but no child doc may weaken DOX

Do not rely on memory. Re-read the applicable DOX chain in the current session before editing.

Update After Editing

Every meaningful change requires a DOX pass before the task is done.

Update the closest owning AGENTS.md when a change affects:

  • purpose, scope, ownership, or responsibilities
  • durable structure, contracts, workflows, or operating rules
  • required inputs, outputs, permissions, constraints, side effects, or artifacts
  • user preferences about behavior, communication, process, organization, or quality
  • AGENTS.md creation, deletion, move, rename, or index contents

Update parent docs when parent-level structure, ownership, workflow, or child index changes. Update child docs when parent changes alter local rules. Remove stale or contradictory text immediately. Small edits that do not change behavior or contracts may leave docs unchanged, but the DOX pass still must happen.

Hierarchy

  • Root AGENTS.md is the DOX rail: project-wide instructions, global preferences, durable workflow rules, and the top-level Child DOX Index
  • Child AGENTS.md files own domain-specific instructions and their own Child DOX Index
  • Each parent explains what its direct children cover and what stays owned by the parent
  • The closer a doc is to the work, the more specific and practical it must be

Child Doc Shape

  • Create a child AGENTS.md when a folder becomes a durable boundary with its own purpose, rules, responsibilities, workflow, materials, or quality standards
  • Work Guidance must reflect the current standards of the project or user instructions; if there are no specific standards or instructions yet, leave it empty
  • Verification must reflect an existing check; if no verification framework exists yet, leave it empty and update it when one exists

Default section order:

  • Purpose
  • Ownership
  • Local Contracts
  • Work Guidance
  • Verification
  • Child DOX Index

Style

  • Keep docs concise, current, and operational
  • Document stable contracts, not diary entries
  • Put broad rules in parent docs and concrete details in child docs
  • Prefer direct bullets with explicit names
  • Do not duplicate rules across many files unless each scope needs a local version
  • Delete stale notes instead of explaining history
  • Trim obvious statements, repeated rules, misplaced detail, and warnings for risks that no longer exist

Closeout

  1. Re-check changed paths against the DOX chain
  2. Update nearest owning docs and any affected parents or children
  3. Refresh every affected Child DOX Index
  4. Remove stale or contradictory text
  5. Run existing verification when relevant
  6. Report any docs intentionally left unchanged and why

User Preferences

When the user requests a durable behavior change, record it here or in the relevant child AGENTS.md

Child DOX Index

  • modules/ — dendritic flake-parts tree (auto-registration, parts.nix, verify.nix, _ exclusion) → modules/AGENTS.md
    • modules/attrs/ — machine-class bundles (desktop, gaming, programming) → modules/attrs/AGENTS.md
    • modules/features/ — opt-in feature modules (import = enable, HM vs NixOS, out-of-store symlinks) → modules/features/AGENTS.md
      • modules/features/noctalia/ — Noctalia shell, cernoh/terminal plugin, ghostty-term helper → modules/features/noctalia/AGENTS.md
      • modules/features/omp/ — Oh My Pi overlay, HM wrapping, managed-skills, plugins, ~/.omp → modules/features/omp/AGENTS.md
    • modules/hosts/ — host presets (NIXPC x86_64, ASAHI aarch64, hardwareFromMachine gate) → modules/hosts/AGENTS.md
    • modules/system/ — cross-host system modules (core, home-manager, network, audio, drivers, …) → modules/system/AGENTS.md
  • .github/ — CI, STE prose lint, workflows, templates → .github/AGENTS.md

Nearest AGENTS.md controls local detail; parent docs supply repo-wide rules. Walk root → target, reading every AGENTS.md on the path.