AI-Cognitive-Leap/agnes-the-ai-analyst
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
agnes-the-ai-analyst/dev_docs/README.md
ZdenekSrotyr a48524509a
docs: consolidate and de-clutter the documentation tree (#306) 
CLAUDE.md rewritten (708 -> ~320 lines): four overlapping release
sections collapsed to one, stale v1->v35 schema history dropped (it
lives in CHANGELOG), marketplace endpoint internals and verbose
process sections moved out or tightened.

New focused docs:
- docs/RELEASING.md - release process, deploy workflows, CI quirks
  (RELEASE_TEMPLATE.md folded in as an appendix)
- docs/marketplace.md - marketplace ingestion + re-serving internals
- docs/README.md - documentation index by audience, linked from
  README.md and CLAUDE.md

Archived under docs/archive/: docs/superpowers/ (52 historical
planning artifacts), HACKATHON.md, pd-ps-comments.md,
security-audit-2026-04.md, future/NOTIFICATIONS.md.

Removed the docs/auto-install.md stub. Fixed dangling links in
connectors/jira/README.md and dev_docs/README.md, repointed
code/doc references to archived paths.
2026-05-14 18:54:22 +00:00

1.4 KiB
Raw Blame History

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

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
  • session_explore.md — session exploration tooling

Jira webhook integration and server-side processing is documented in ../connectors/jira/README.md.

For Analysts

If you're an analyst looking for documentation on how to use the platform, see the docs/ folder instead — start at ../docs/README.md for the full index. Key entry points:

  • docs/QUICKSTART.md — quick start guide
  • docs/DATA_SOURCES.md — data sources and table definitions
  • docs/metrics/ — business metric definitions
  • docs/HOWTO/ — task-oriented analyst cookbook