Skip to content

docs: developer documentation, ADRs, CI fixes#21

Merged
DeepRatAI merged 14 commits intomainfrom
docs/developer-documentation
Feb 26, 2026
Merged

docs: developer documentation, ADRs, CI fixes#21
DeepRatAI merged 14 commits intomainfrom
docs/developer-documentation

Conversation

@DeepRatAI
Copy link
Owner

Summary

Comprehensive developer documentation and CI integrity fixes.

Closes #10

Changes

New Files

  • docs/DEVELOPMENT.md — Complete dev environment setup guide (prerequisites, quick start, Docker Compose, env vars, API server, Reflex UI, testing, troubleshooting)
  • docs/adr/0001-reflex-migration.md — ADR documenting the Streamlit → Reflex migration decision with trade-offs
  • docs/adr/0002-agent-architecture.md — ADR documenting the multi-agent medical architecture (controller, routing, tools)

Updated Files

  • CONTRIBUTING.md — Added Docker setup, environment variables, Reflex UI instructions, troubleshooting section; updated clone URLs from Med-X-KimiK2-RAG → MedX; linked to DEVELOPMENT.md
  • pyproject.toml — Added [tool.bandit] config: skip B104 (bind-all-interfaces) with engineering justification (Docker-containerized server)
  • .github/workflows/ci.yml — Removed standalone isort step (ruff I001 already handles import sorting; isort and ruff disagree on aliased imports, creating an unresolvable conflict). Added explanatory comment with reference to ruff FAQ.
  • src/medex/api/__init__.py — Consolidated WebSocketMessage aliased import into single block to satisfy ruff I001

CI Status

All 4 required CI jobs verified locally:

  • ruff check src/ tests/ — 0 errors
  • black --check src/ tests/ — 113 files clean
  • pytest stable tests — 97/97 passed
  • bandit -r src/ -c pyproject.toml -ll — 0 findings (B104 intentionally excluded)
  • ✅ Secrets scan — no hardcoded keys

Issue #10 Checklist

  • Auto-generated API reference (OpenAPI/Swagger) — documented in DEVELOPMENT.md
  • Module-level docstring standardization — all 14 packages audited, all have docstrings
  • Architecture decision records — ADR-0001 (Reflex), ADR-0002 (Agent arch), plus existing 0003-0005
  • Contributing guide with examples — CONTRIBUTING.md enhanced
  • Development environment setup guide — docs/DEVELOPMENT.md

Gonzalo

@DeepRatAI DeepRatAI added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 26, 2026
@DeepRatAI DeepRatAI added this to the v0.1.1 - Patch milestone Feb 26, 2026
@DeepRatAI DeepRatAI merged commit 56a014a into main Feb 26, 2026
8 checks passed
@DeepRatAI DeepRatAI deleted the docs/developer-documentation branch February 26, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create developer documentation and API reference

1 participant