agnes-the-ai-analyst/dev_docs
ZdenekSrotyr 8233c3e3f9 chore(docs): replace stale da verbs and vendor-specific install paths
Sweep operator runbooks (docs/QUICKSTART, docs/HEADLESS_USAGE,
docs/architecture, docs/sample-data, docs/agent-workspace-prompt,
docs/metrics/metrics.yml, dev_docs/server, dev_docs/disaster-recovery),
the corporate-memory service README, the jira connector README + backfill
scripts, the deploy skill, and test docstrings. Replaces `da sync` →
`agnes pull`, `da analyst setup` → `agnes init`, `da metrics ...` →
`agnes catalog --metrics` / `agnes admin metrics ...`, `da fetch` →
`agnes snapshot create`, plus the matching docker-compose admin
invocations.

Vendor-specific `/opt/data-analyst/` install paths in jira backfill /
consistency scripts and operator docs are replaced with the
placeholder `<install-dir>` and a new `AGNES_ENV_FILE` env-var override
that lets a deployment inject its actual install path without a code
change. Aligns with the OSS vendor-agnostic policy in CLAUDE.md.

CHANGELOG `### Internal` entry summarizes the audit and reaffirms the
intentional stale-marker tuples (`_LEGACY_STRINGS`, `_OUR_COMMAND_MARKERS`)
that must keep referencing `da sync` / `da fetch` / etc. for hook upgrade
and override-detection logic.
2026-05-04 21:22:19 +02:00
..
design-system.md Initial commit: OSS data distribution platform 2026-03-08 23:31:28 +01:00
desktop-app.md Update paths in docs and sudoers after services/ extraction 2026-03-09 13:02:13 +01:00
disaster-recovery.md chore(docs): replace stale da verbs and vendor-specific install paths 2026-05-04 21:22:19 +02:00
insights.md chore: clean repo for public release — fix references, remove drafts 2026-04-08 19:27:25 +02:00
README.md docs: update references to deleted files 2026-04-09 17:15:19 +02:00
security.md Update paths in docs and sudoers after services/ extraction 2026-03-09 13:02:13 +01:00
server.md chore(docs): replace stale da verbs and vendor-specific install paths 2026-05-04 21:22:19 +02:00
session_explore.md Security fixes: sanitize dev_docs, harden sudoers and config validation 2026-03-09 08:06:45 +01:00
telegram_bot.md feat(observability): request_id end-to-end + dev debug toolbar + centralized logging (#136) 2026-04-29 22:54:21 +02:00

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