docs: documentation for user agents - #9
Merged
Conversation
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CLOSE #7