22cfbfe5fb
- QUICKSTART.md: replace data_description.md.example copy step with note that tables are registered via the admin API or web UI - NOTIFICATIONS.md: replace examples/ section with planned-feature note - telegram_bot.md: remove examples/notifications/ rows from deployment table and example scripts section; note feature is planned - dev_docs/README.md: remove plan-corporate-memory.md entry - duckdb_manager.py: update comment from remote_query.py to query API endpoint
31 lines
1.3 KiB
Markdown
31 lines
1.3 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
|
|
- `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
|