Arnike/duty-teller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 14 Wiki Activity
Files
v1.1.2
duty-teller/docs/index.md
Nikolay Tatarinov 86f6d66865
All checks were successful
CI / lint-and-test (push) Successful in 17s
Details
chore: add changelog and documentation updates 
- 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.
2026-02-20 15:32:10 +03:00

676 B
Raw Permalink 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.