Nikolay Tatarinov
86f6d66865
All checks were successful
CI / lint-and-test (push) Successful in 17s
- Created a new `CHANGELOG.md` file to document all notable changes to the project, adhering to the Keep a Changelog format. - Updated `CONTRIBUTING.md` to include instructions for building and previewing documentation using MkDocs. - Added `mkdocs.yml` configuration for documentation generation, including navigation structure and theme settings. - Enhanced various documentation files, including API reference, architecture overview, configuration reference, and runbook, to provide comprehensive guidance for users and developers. - Included new sections in the README for changelog and documentation links, improving accessibility to project information.
14 lines
676 B
Markdown
14 lines
676 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).
|