Add LLM-optimized documentation (llms.txt + llms-full.txt)#10
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Adds LLM-oriented, single-file documentation for RowQuery (llms-full.txt) plus a lightweight llms.txt index to improve AI tool ingestion and Q&A accuracy, and updates branch metadata in CLAUDE.md.
Changes:
- Added
llms-full.txtwith consolidated API documentation and examples for engines, config, registry/sanitizer, mapping, transactions, migrations, repositories, and exceptions. - Added
llms.txtindex linking to sections inllms-full.txt. - Updated
CLAUDE.mdwith notes for the001-llm-docsbranch.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| llms.txt | Adds an llms.txt-spec index pointing into the consolidated documentation. |
| llms-full.txt | Adds comprehensive, single-file RowQuery documentation with examples and reference sections. |
| CLAUDE.md | Adds branch-specific “Active Technologies” and “Recent Changes” entries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [Transactions](llms-full.txt#transactions): Sync and async transaction management | ||
| - [Migrations](llms-full.txt#migrations): Schema migration with MigrationManager | ||
| - [Repository Pattern](llms-full.txt#repository-pattern): DDD-style repository base classes | ||
| - [Exception Reference](llms-full.txt#exception-reference): Complete exception hierarchy (18 classes) |
There was a problem hiding this comment.
This link description says the exception hierarchy has 18 classes, but row_query/core/exceptions.py currently defines 20 exception classes (including base categories and leaf errors). Please update the count (or remove the count) to keep this index accurate.
| - [Exception Reference](llms-full.txt#exception-reference): Complete exception hierarchy (18 classes) | |
| - [Exception Reference](llms-full.txt#exception-reference): Complete exception hierarchy |
| ```python | ||
| # Using uv (recommended) | ||
| # uv add row-query | ||
|
|
||
| # Using pip | ||
| # pip install row-query | ||
| ``` |
There was a problem hiding this comment.
This fenced block is labeled as python, but it contains shell install commands. Use a bash/sh (or plain text) code fence here so syntax highlighting and copy/paste expectations match the content.
|
@copilot open a new pull request to apply changes based on the comments in this thread |
|
@MaksimShevtsov I've opened a new pull request, #11, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: MaksimShevtsov <20194438+MaksimShevtsov@users.noreply.github.com>
Fix inaccuracies in LLM documentation (llms-full.txt + llms.txt)
Summary
llms-full.txt— comprehensive single-file documentation (~880 lines) covering all RowQuery public API: Engine, ConnectionConfig, SQLRegistry, SQLSanitizer, Result Mapping (ModelMapper + AggregateMapper), Transactions, Migrations, Repository Pattern, Database Backends (SQLite/PostgreSQL/MySQL/Oracle), Exception Reference, and Terminology Glossaryllms.txt— lightweight index following the llms.txt specification with section links into llms-full.txtTest plan
llms.txtresolve to headings inllms-full.txtllms-full.txtinto an AI assistant and ask basic RowQuery questions (install, quick start, backend config) — verify accurate answerspythonblocks with complete importsspecs/001-llm-docs/research.md🤖 Generated with Claude Code