agnes-the-ai-analyst/dev_docs/README.md
Petr c56905d34f Initial commit: OSS data distribution platform
Open-source AI data analyst platform extracted from internal repo.
Includes data sync engine, Keboola adapter, Flask web portal,
server deployment scripts, and configuration templates.
2026-03-08 23:31:28 +01:00

32 lines
1.4 KiB
Markdown

# Developer Documentation
This folder contains documentation for **developers and server administrators** only.
**⚠️ This folder is NOT synced to analyst machines** - it stays on the server and in the git repository only.
## Contents
### Server Administration
- `server.md` - Data broker server configuration and management
- `disaster-recovery.md` - Recovery procedures for server failures
- `security.md` - Security audit report and hardening guidelines
- `jira.md` - Jira webhook integration and server-side processing
### Application Development
- `desktop-app.md` - macOS desktop app architecture and development
- `telegram_bot.md` - Telegram notification bot technical docs
- `design-system.md` - UI/UX design system for web applications
- `insights.md` - Activity Center dashboard feature documentation
### Planning & Meetings
- `plan-corporate-memory.md` - Corporate Memory module implementation plan
- `meetings/` - Meeting transcripts, summaries, and notes
## For Analysts
If you're an analyst looking for documentation on how to **use** the platform, see the `docs/` folder instead:
- `docs/GETTING_STARTED.md` - Quick start guide
- `docs/data_description.md` - Data schemas and table definitions
- `docs/metrics/` - Business metric definitions
- `docs/jira_schema.md` - Jira data schema reference
- `docs/notifications.md` - How to use Telegram notifications in your scripts