Skip to content

Bootstrap AGENTS.md and agent documentation - #691

Merged
paulsmirnov merged 2 commits into
mainfrom
add-agents-md
Sep 1, 2026
Merged

paulsmirnov merged 2 commits into
mainfrom
add-agents-md

Conversation

@paulsmirnov

Copy link
Copy Markdown
Member

Description

Replaces the monolithic .github/copilot-instructions.md with a compact, hub-and-spoke agent guidance architecture centered on AGENTS.md and specialized documentation in docs/agents/, CONTEXT.md, and DESIGN.md.

Key improvements:

  • Reduces token footprint on every agent prompt / context cycle (~80% reduction in root instruction size).
  • Establishes a modular documentation layout for architecture (docs/agents/architecture.md), code style (docs/agents/code-style.md), domain terminology (CONTEXT.md), design system (DESIGN.md), and issue triage workflow (docs/agents/issue-tracker.md, docs/agents/triage-labels.md).
  • Retains an inline code completion cache in .github/copilot-instructions.md for non-agentic inline completion engines.
  • Introduces living documentation files (docs/agents/lessons-learned.md) to capture domain patterns and common pitfalls.

Type of changes

  • New feature (non-breaking change that adds functionality)

Checklist

  • I have read CONTRIBUTING and CODE_OF_CONDUCT guides.
  • I have followed the code style of this project.
  • I have run yarn run ci: lint and tests pass locally with my changes.
  • I have added tests that prove my fix/feature works OR The changes do not require updated tests.
  • I have added the necessary documentation OR The changes do not require updated docs.

@NadezhdaKatcman NadezhdaKatcman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No comments. Thank you!

@paulsmirnov
paulsmirnov merged commit 8eece79 into main Sep 1, 2026
6 checks passed
@paulsmirnov
paulsmirnov deleted the add-agents-md branch September 1, 2026 16:35
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.

2 participants