docs(release): PRD + 5 ADRs + diagram + bump v1.0.0#5
Merged
Conversation
Documentation pass for the v1.0.0 cut. README polished, version
bumped, full architectural rationale committed.
- docs/PRD.md — product requirements, scope decisions (in vs out),
stack choices with the *why*, risk table. Sanitised version of the
internal planning doc.
- docs/adr/ (5 ADRs):
001 Chainlit over Streamlit / Gradio
002 OpenRouter as unified LLM gateway
003 Claude Haiku 4.5 as default chat model
004 Fly.io over Hugging Face Spaces (portfolio consistency)
005 create_agent over LCEL + RunnableWithMessageHistory (legacy
pattern absent from current LangChain docs)
Plus README index and template.
- docs/diagrams/conversation-flow.md — Mermaid sequence diagram showing
the user → Chainlit → agent → OpenRouter path, including the optional
Tavily branch.
- README — quickstart, stack table with *why* per row + ADR pointers,
endpoints / project layout / testing sections, related repos.
- Version: 0.1.0 → 1.0.0 in app/__init__.py + pyproject.toml + uv.lock
+ the smoke test assertion.
heitor-am
force-pushed
the
docs/v1-release
branch
from
b0ee077 to
0f327b4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation pass for the
v1.0.0cut. After merge: tagv1.0.0, GitHub release.What's in
docs/PRD.md— product requirements, scope decisions (explicit in / out), stack picks with the why, risk table. Public-facing version of the planning doc.docs/adr/— 5 ADRs covering every load-bearing choice:create_agentover legacy LCEL +RunnableWithMessageHistorydocs/diagrams/conversation-flow.md— Mermaid sequence diagram showing user → Chainlit → agent → OpenRouter, including the optional Tavily branch.0.1.0→1.0.0inapp/__init__.py,pyproject.toml,uv.lock, smoke test.Test plan
uv run ruff check ./format --check— passesuv run mypy app— passes (strict)uv run pytest— 31 passed, 100% coverage on app/