Skip to content

docs: Add session deliverables and comprehensive documentation updates#971

Merged
abrichr merged 4 commits intomainfrom
feature/documentation-session-deliverables
Jan 17, 2026
Merged

docs: Add session deliverables and comprehensive documentation updates#971
abrichr merged 4 commits intomainfrom
feature/documentation-session-deliverables

Conversation

@abrichr
Copy link
Member

@abrichr abrichr commented Jan 17, 2026

Summary

  • New design documents: Added 5 design specifications in docs/design/ covering tray application architecture, logging, landing page strategy, telemetry, and repository rename analysis
  • New strategic documents: Added publication roadmap and project priorities/roadmap documentation
  • Updated package documentation: Refreshed documentation for all 7 sub-packages (capture, evals, grounding, ml, privacy, retrieval, viewer)
  • Core documentation updates: Updated architecture-evolution.md to v3.0, improved quickstart guide, CLI docs, and main index

New Files

File Description
docs/design/openadapt-tray.md Comprehensive tray application design
docs/design/tray-logging.md Logging system design for tray app
docs/design/landing-page-strategy.md Website and landing page strategy
docs/design/telemetry-design.md Telemetry and analytics design
docs/design/repo-rename-analysis.md Repository rename analysis
docs/publication-roadmap.md Publication and research roadmap
docs/roadmap-priorities.md Project priorities and roadmap

Updated Files

  • docs/architecture-evolution.md - Updated to version 3.0
  • docs/architecture.md - Architecture improvements
  • docs/index.md - Main documentation index
  • docs/cli.md - CLI documentation updates
  • docs/getting-started/quickstart.md - Quickstart guide updates
  • docs/packages/*.md - All 7 package docs updated

Test plan

  • Verify all markdown files render correctly on GitHub
  • Check all internal links are valid
  • Review documentation for accuracy and completeness
  • Verify MkDocs builds successfully (if applicable)

🤖 Generated with Claude Code

abrichr and others added 4 commits January 16, 2026 23:51
New design documents:
- docs/design/openadapt-tray.md - Comprehensive tray application design
- docs/design/tray-logging.md - Logging system design for tray app
- docs/design/landing-page-strategy.md - Website and landing page strategy
- docs/design/telemetry-design.md - Telemetry and analytics design
- docs/design/repo-rename-analysis.md - Repository rename analysis

New strategic documents:
- docs/publication-roadmap.md - Publication and research roadmap
- docs/roadmap-priorities.md - Project priorities and roadmap

Updated documentation:
- docs/architecture-evolution.md - Updated to version 3.0
- docs/architecture.md - Architecture improvements
- docs/index.md - Main documentation index
- docs/cli.md - CLI documentation updates
- docs/getting-started/quickstart.md - Quickstart guide updates
- docs/packages/*.md - Updated package documentation for:
  capture, evals, grounding, ml, privacy, retrieval, viewer

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Model Layer now shows two categories:
- API Models: Claude, GPT-4o, Gemini
- Open Source / Fine-tuned: Qwen3-VL, UI-TARS, OpenCUA

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added to nav:
- Architecture Evolution document
- Design docs (tray, telemetry, landing page, etc.)
- Roadmap docs (priorities, publications)
- macOS permissions reference
- Legacy freeze documents

Fixes MkDocs strict mode warnings about orphaned pages.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@abrichr abrichr merged commit 94c17f8 into main Jan 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant