Skip to content

Add LLM-optimized documentation (llms.txt + llms-full.txt)#10

Merged
MaksimShevtsov merged 4 commits into
mainfrom
001-llm-docs
Feb 22, 2026
Merged

Add LLM-optimized documentation (llms.txt + llms-full.txt)#10
MaksimShevtsov merged 4 commits into
mainfrom
001-llm-docs

Conversation

@MaksimShevtsov
Copy link
Copy Markdown
Owner

Summary

  • Add 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 Glossary
  • Add llms.txt — lightweight index following the llms.txt specification with section links into llms-full.txt
  • Update CLAUDE.md with active technologies for the 001-llm-docs feature branch

Test plan

  • Verify all anchor links in llms.txt resolve to headings in llms-full.txt
  • Paste llms-full.txt into an AI assistant and ask basic RowQuery questions (install, quick start, backend config) — verify accurate answers
  • Confirm all code examples use fenced python blocks with complete imports
  • Check terminology consistency against canonical terms in specs/001-llm-docs/research.md

🤖 Generated with Claude Code

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 22, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.txt with consolidated API documentation and examples for engines, config, registry/sanitizer, mapping, transactions, migrations, repositories, and exceptions.
  • Added llms.txt index linking to sections in llms-full.txt.
  • Updated CLAUDE.md with notes for the 001-llm-docs branch.

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.

Comment thread llms-full.txt Outdated
Comment thread llms.txt Outdated
- [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)
Copy link

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [Exception Reference](llms-full.txt#exception-reference): Complete exception hierarchy (18 classes)
- [Exception Reference](llms-full.txt#exception-reference): Complete exception hierarchy

Copilot uses AI. Check for mistakes.
Comment thread llms.txt
Comment thread llms-full.txt Outdated
Comment thread llms-full.txt Outdated
Comment on lines +35 to +41
```python
# Using uv (recommended)
# uv add row-query

# Using pip
# pip install row-query
```
Copy link

Copilot AI Feb 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
Comment thread llms-full.txt Outdated
@MaksimShevtsov
Copy link
Copy Markdown
Owner Author

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 22, 2026

@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.

Copilot AI and others added 2 commits February 22, 2026 17:19
Co-authored-by: MaksimShevtsov <20194438+MaksimShevtsov@users.noreply.github.com>
Fix inaccuracies in LLM documentation (llms-full.txt + llms.txt)
@MaksimShevtsov MaksimShevtsov merged commit a058039 into main Feb 22, 2026
14 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.

4 participants