dgenio / dgenio/contextweaver

Document AGENTS.md/Dox-style static context as a complement to runtime context compilation

Open Beginner friendly
#421 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

complexity:simple priority:low
Dominant language
Python
Stars
9
Forks
17
Avg merge
21h 36m
Merged PRs (30d)
22

Description

Context

Dox frames AGENTS.md as a lightweight static project-context hierarchy: root instructions plus local child instructions that agents read before editing. This is not a runtime context compiler, but it addresses a related failure mode: agents editing code without understanding local project contracts.

contextweaver solves the runtime side: bounded context packs, tool routing, ChoiceCards, and result firewalling. The relationship is complementary and worth documenting clearly.

Proposed scope

Add a short docs page or comparison section explaining how static project instruction trees relate to contextweaver.

Possible framing:

AGENTS.md / Dox-style tree: durable local project guidance before coding/editing.
contextweaver: phase-specific runtime context compilation for tool-heavy agents.
lessonweaver: reviewed lessons exported into instruction surfaces.
VibeGuard: deterministic checks that instruction trees do not drift.

Acceptance criteria

  • Add documentation showing where AGENTS.md/Dox-style local context fits relative to contextweaver.
  • Clarify that contextweaver does not require Dox and Dox does not replace runtime context compilation.
  • Include at least one practical scenario:
    • coding agent reads local AGENTS.md before editing;
    • runtime agent uses contextweaver to select ChoiceCards / compile a prompt;
    • the two solve different context surfaces.
  • Link to lessonweaver and vibeguard only where relevant, without making the page feel like a marketing bundle.

Non-goals

  • Do not add a Dox runtime dependency.
  • Do not claim Dox-style docs solve prompt budget, tool routing, or result firewalling.
  • Do not expand contextweaver scope into project documentation management.

Why this matters

People may conflate static project context with runtime context compilation. A clear comparison helps position contextweaver as the runtime/budgeted-context layer while acknowledging the value of local AGENTS.md conventions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the repository's documentation structure and existing contextweaver references. Add a concise comparison covering AGENTS.md/Dox-style guidance, runtime context compilation, and one practical scenario, while linking lessonweaver and vibeguard only where relevant; done means all acceptance criteria and non-goals are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ai, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.