Skip to content

docs: documentation for user agents - #9

Merged
MgnMtn merged 1 commit into
mainfrom
7-docs-add-agent-documentation
Jul 10, 2026
Merged

docs: documentation for user agents#9
MgnMtn merged 1 commit into
mainfrom
7-docs-add-agent-documentation

Conversation

@MgnMtn

@MgnMtn MgnMtn commented Jul 10, 2026

Copy link
Copy Markdown
Member

CLOSE #7

@MgnMtn
MgnMtn requested a review from Copilot July 10, 2026 09:45
@MgnMtn MgnMtn linked an issue Jul 10, 2026 that may be closed by this pull request

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a structured documentation set for humans and AI agents to work effectively in the multiplex repo, including an index, architecture/pipeline overview, configuration schema, module/function reference, extension checklists, and development/agent guidance (Issue #7).

Changes:

  • Introduces docs/ documentation set (index + architecture, config, module reference, extending, development guides).
  • Adds agent-focused entrypoints (AGENTS.md, CLAUDE.md) pointing to the task-scoped docs and common commands.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/README.md Index entrypoint for the new task-scoped documentation set.
docs/ARCHITECTURE.md Describes end-to-end pipeline, approaches, backends, and artifacts.
docs/MODULE_REFERENCE.md Function/signature-oriented reference for key modules.
docs/CONFIG.md Documents config.yml schema and required keys.
docs/EXTENDING.md Checklists for adding approaches, backends, and providers.
docs/DEVELOPMENT.md Developer setup, conventions, CI notes, known issues.
AGENTS.md Guidance and doc map for AI coding agents working in-repo.
CLAUDE.md Claude Code-specific guidance and doc map for the repo.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/DEVELOPMENT.md
Comment thread AGENTS.md
Comment thread CLAUDE.md
@MgnMtn
MgnMtn merged commit d5fef6e into main Jul 10, 2026
3 checks passed
@MgnMtn
MgnMtn deleted the 7-docs-add-agent-documentation branch July 10, 2026 10:02
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.

docs: add agent documentation

2 participants