Skip to content

ThinkAI readiness: Project context map #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thinkai-platform-insights wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ThinkAI readiness: Project context map #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Agent context map

This file is the entry point for AI-assisted development. Long-lived project context lives in the documents below—not in chat history. Read the relevant guides before making changes.

## Canonical context sources

| Topic | Document |
| --- | --- |
| Local development, Docker Compose, linting, tests | [development.md](development.md) |
| Production deployment, Traefik, CI/CD | [deployment.md](deployment.md) |
| Backend layout, models, API, uv workflow | [backend/README.md](backend/README.md) |
| Frontend stack, Vite/React, client generation | [frontend/README.md](frontend/README.md) |
| Contribution workflow, PR expectations, AI use | [CONTRIBUTING.md](CONTRIBUTING.md) |

The root [README.md](README.md) summarizes the stack and how to use the template.

## Conventions for agents

- Prefer small, focused changes; match existing patterns in the touched area.
- Run or update tests when changing behavior; see [development.md](development.md) for how to run the stack and test suites.
- Do not commit secrets (`.env`, credentials) or skip hooks unless the user explicitly asks.
- Follow [CONTRIBUTING.md](CONTRIBUTING.md) for discussions, PR scope, and meaningful human review of AI-assisted work.