Nikolay Tatarinov
37d4226beb
- Added AGENTS.md for AI agent documentation and maintainers, outlining project structure and conventions. - Updated CONTRIBUTING.md to specify that all project documentation must be in English, including README and docstrings. - Enhanced README.md to reference documentation guidelines and the new AGENTS.md file. - Cleaned up .gitignore by removing unnecessary entries for cursor-related files. - Introduced new .cursor rules for backend, frontend, project architecture, and testing to standardize development practices.
16 lines
924 B
Markdown
16 lines
924 B
Markdown
# Duty Teller
|
|
|
|
Telegram bot for team duty shift calendar and group reminder. The bot and web UI support **Russian and English**.
|
|
|
|
## Documentation
|
|
|
|
- [Configuration](configuration.md) — Environment variables (types, defaults, examples).
|
|
- [Architecture](architecture.md) — Components, data flow, package relationships.
|
|
- [Import format](import-format.md) — Duty-schedule JSON format and example.
|
|
- [Runbook](runbook.md) — Running the app, logs, common errors, DB and migrations.
|
|
- [API Reference](api-reference.md) — Generated from code (api, db, services, handlers, importers, config).
|
|
|
|
For quick start, setup, and API overview see the main [README](../README.md).
|
|
|
|
**For maintainers and AI:** Project documentation and docstrings must be in English; see [CONTRIBUTING.md](../CONTRIBUTING.md#documentation). [AGENTS.md](../AGENTS.md) in the repo root provides entry points, conventions, and where to change what.
|