Arnike/duty-teller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 14 Wiki Activity
Files
7ffa727832977caec0d587d82c00612325ce7f98
duty-teller/docs/index.md
Nikolay Tatarinov 37d4226beb chore: update project documentation and configuration files 
- 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.
2026-03-02 20:02:20 +03:00

924 B
Raw Blame History

Duty Teller

Telegram bot for team duty shift calendar and group reminder. The bot and web UI support Russian and English.

Documentation

  • Configuration — Environment variables (types, defaults, examples).
  • Architecture — Components, data flow, package relationships.
  • Import format — Duty-schedule JSON format and example.
  • Runbook — Running the app, logs, common errors, DB and migrations.
  • API Reference — Generated from code (api, db, services, handlers, importers, config).

For quick start, setup, and API overview see the main README.

For maintainers and AI: Project documentation and docstrings must be in English; see CONTRIBUTING.md. AGENTS.md in the repo root provides entry points, conventions, and where to change what.