Skip to content

docs(context): add 3-tier progressive disclosure documentation#23

Merged
gcko merged 2 commits intomainfrom
feature/update-context
Feb 7, 2026
Merged

docs(context): add 3-tier progressive disclosure documentation#23
gcko merged 2 commits intomainfrom
feature/update-context

Conversation

@gcko
Copy link
Copy Markdown
Owner

@gcko gcko commented Feb 7, 2026

PR checklist

  • Ensure you have added or ran the appropriate tests for your PR.
  • DCO signed

What type of PR is this?

Documentation refactoring

What this PR does / why we need it:

Refactors project documentation into a structured 3-tier progressive disclosure system optimized for AI coding agents:

  • Tier 1a: AGENTS.md (universal) - Refactored with tech stack, "where to add code" table, critical constraints, common pitfalls, and cross-references
  • Tier 1b: CLAUDE.md (new) - Claude-specific extensions: architecture quick reference, code patterns with examples, debugging playbook, CI/CD details
  • Tier 2: docs/KNOWLEDGE_BASE.md (new) - Table of contents with 1-2 line summaries pointing to detailed docs
  • Tier 3: docs/*.md (new) - Comprehensive documentation: architecture.md, development.md, troubleshooting.md

Which issue(s) this PR fixes:

N/A - documentation improvement

Special notes for your reviewer:

  • AGENTS.md is 103 lines (under 150-line limit), containing only universal agent instructions
  • CLAUDE.md is 48 lines (under 95-line limit), with @AGENTS.md import as first line
  • KNOWLEDGE_BASE.md is a TOC only (18 lines), no full content
  • No changes to source code or tests

Does this PR introduce a user-facing change?:

NONE

gcko and others added 2 commits February 7, 2026 12:24
Refactor project documentation into a structured 3-tier system for
AI coding agents: AGENTS.md (universal), CLAUDE.md (Claude-specific),
KNOWLEDGE_BASE.md (TOC), and detailed docs/ files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Jared Scott <jared.scott@variable.team>
…EADME

Add 2.4.0 and 2.5.0 entries to CHANGELOG.md. Convert plain-text file
references in README.md to proper markdown links for LICENSE, CHANGELOG,
CONTRIBUTING, and SECURITY files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Jared Scott <jared.scott@variable.team>
@gcko gcko merged commit 7bb0a72 into main Feb 7, 2026
6 checks passed
@gcko gcko deleted the feature/update-context branch February 7, 2026 04:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant