Docs: finish and expand why-chatlas.qmd
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 176
- Forks
- 28
- Avg merge
- 18h 42m
- Merged PRs (30d)
- 16
Description
Problem
docs/why-chatlas.qmd ends mid-sentence:
Other frameworks like Pydantic AI and llm do a better
The page currently only compares chatlas against LangChain (via the conversation-history example), and the file is rendered by the site build (listed in docs/_quarto.yml's render: block) but is not linked from any sidebar — docs/_sidebar.yml only covers the API reference, and the get-started/tool-calling/misc sidebar defined in docs/_quarto.yml (lines ~81-121) doesn't include it either. The only inbound link found is docs/index.qmd's "## Why chatlas?" section header, which doesn't appear to hyperlink to why-chatlas.qmd itself. So today the page is essentially orphaned/unfinished content live on the site.
Proposed approach
- Finish the cut-off sentence and complete the framework comparison using the July 2026 competitive review findings, with honest, specific positioning rather than generic "worse than us" claims:
- llm: CLI-first, SQLite-backed logging, huge plugin ecosystem — owns shell-scripting and local-model tinkering; chatlas is a library for building the plumbing has to go in your app.
- Pydantic AI: production agent framework with strong type-safety and structured-output validation baked deep into the agent loop; growing in surface area (graphs, dependency injection) as it matures.
- LangChain: broad agent-platform/ecosystem (integrations, LangGraph, LangSmith); breadth comes with a steeper learning curve and more indirection for simple chat use cases (as the existing conversation-history example already demonstrates).
- LiteLLM: gateway/proxy breadth — unify billing/routing across many providers' APIs; complementary to, not a substitute for, an SDK-level chat library like chatlas.
- Add a short "what chatlas deliberately doesn't do" section: no agent graphs/orchestration, no RAG/vector-store primitives (see
docs/misc/RAG.qmd's existing llama-index recommendation), no middleware layer, no multi-provider gateway/proxy. - Call out underexploited differentiators that don't get enough airtime elsewhere in the docs: stateful
Chatergonomics (turns retained automatically),batch_chat/batch_chat_text/batch_chat_structuredprovider-discount batch support (reference/batch_chat.qmd), first-class notebook/console streaming UX, and OpenTelemetry instrumentation out of the box (get-started/monitor.qmd). - Fix the orphaned-page problem: either add
why-chatlas.qmdto the sidebar (e.g., under theindex.qmdentry indocs/_quarto.yml's sidebarcontents) or link to it directly fromdocs/index.qmd's "Why chatlas?" heading — confirm which with the maintainer before choosing.
This issue is a task description, not the content — the actual writing happens in the PR.
Alternatives / prior art
Related to #89 ("Add a why chatlas article", closed — the original article this issue would complete).
Open questions
- Sidebar placement vs. inline link from
index.qmd— which is preferred? - Should the LangChain example be kept as-is, trimmed, or replaced now that other frameworks are being added?
Drafted from a competitive review of llm / Pydantic AI / LangChain / LiteLLM (July 2026); filed via Claude Code on behalf of @cpsievert.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/why-chatlas.qmd, then inspect the render and sidebar entries in docs/_quarto.yml, docs/_sidebar.yml, and the Why chatlas? section in docs/index.qmd. Confirm the preferred navigation with the maintainer, complete the comparison and differentiators described in the issue, and verify the finished page is rendered and reachable from the site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100