docs: Add comprehensive AGENTS.md documentation for AI agents #1814
Conversation
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
Add detailed AGENTS.md files throughout the repository to help AI agents understand the Kleinkram codebase architecture and implementation details. Documentation includes: - Root-level system overview and architecture diagram - Backend API architecture and endpoint documentation - Queue Consumer job processing and Docker orchestration - Frontend Vue 3 architecture and state management - CLI Python interface and file transfer - Common module entities, DTOs, and shared code Each AGENTS.md file provides: - Component purpose and responsibilities - Project structure and key files - Architecture patterns and data flows - Common development tasks - Important implementation details - Related documentation links These documents are designed to be read by AI coding assistants to enable them to work more effectively with the codebase.
|
@Idate96, you can ignore the failed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds comprehensive AGENTS.md documentation files throughout the repository to help AI agents (like Claude Code, GitHub Copilot, etc.) understand the Kleinkram codebase architecture and implementation details.
What's included
Documentation has been added at multiple levels:
/AGENTS.md- Root-level system overview with architecture diagram, data flows, and navigation/backend/AGENTS.md- Backend API architecture, endpoints, middleware, authentication, services/queueConsumer/AGENTS.md- Queue consumer architecture, job processing, Docker orchestration, file processing/frontend/AGENTS.md- Frontend Vue 3 architecture, state management, upload system, routing/cli/AGENTS.md- CLI Python interface, commands, file transfer/common/AGENTS.md- Shared entities, DTOs, enums, validation patternsEach AGENTS.md file includes:
Why this matters
These documents enable AI coding assistants to:
Total documentation
Notes