Skip to content

docs: v0.4 pre-release documentation polish - #184

Merged
leocamello merged 1 commit into
mainfrom
023-v04-docs-polish
Feb 18, 2026
Merged

leocamello merged 1 commit into
mainfrom
023-v04-docs-polish

Conversation

@leocamello

Copy link
Copy Markdown
Owner

Summary

Update all documentation to reflect v0.4 feature completion (F15-F18).

Changes

README.md

  • Added quality tracking, embeddings API, and request queuing to features list
  • Updated architecture diagram to include cloud backends and v0.4 capabilities

docs/roadmap.md

  • F15 Speculative Router: Planned → ✅ Complete with spec link
  • F16/F17/F18: issue links → spec folder links
  • v0.4 status: 🚧 In Progress → ✅ Complete
  • What's Next: updated from v0.4 remaining to v0.5 Orchestration

docs/architecture.md

  • Added Component 11: Request Queue (src/queue/)
  • Added POST /v1/embeddings to endpoints table and code example
  • Updated QualityReconciler from "reserved/pass-through" to active with real metrics
  • Marked Speculative Router as "Implemented"
  • Added quality tracker and queue drain loop to background services diagram

.github/copilot-instructions.md

  • Roadmap: v0.3 Next → ✅ Released, v0.4 Planned → ✅ Released
  • Module structure: added queue/ module
  • API endpoints: added POST /v1/embeddings
  • Key types: added RequestQueue and QueuedRequest

docs/getting-started.md

  • Added [quality] and [queue] configuration sections

specs/020-embeddings-api/research.md

  • Fixed stale TODO about hardcoded model names (resolved in implementation)

- README.md: add quality tracking, embeddings, and request queuing features;
  update architecture diagram with OpenAI cloud backend
- roadmap.md: mark F15 as Complete, v0.4 as Complete, link all feature specs,
  update What's Next to v0.5
- architecture.md: add queue module (component 11), /v1/embeddings endpoint,
  quality tracker and queue drain loop to background services,
  update QualityReconciler from reserved to active,
  mark Speculative Router as implemented
- copilot-instructions.md: update roadmap table (v0.3/v0.4 Released),
  add queue module and types, add /v1/embeddings endpoint
- getting-started.md: add [quality] and [queue] config sections
- research.md (F17): fix stale TODO about hardcoded model names
@leocamello leocamello added the documentation Improvements or additions to documentation label Feb 18, 2026
@leocamello
leocamello merged commit 1cdc26f into main Feb 18, 2026
9 checks passed
@leocamello
leocamello deleted the 023-v04-docs-polish branch February 18, 2026 02:43
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant