Repository navigation
docs: llms.txt, llms-full.txt and AGENTS.md - #68
Merged
Merged
Conversation
llms.txt (llmstxt.org) is a short introduction for AI assistants: what pgraph is, a quick start, key points and common mistakes, then links; llms-full.txt is the whole Sphinx site as plain text, API reference included. Both are built by docs/llms_txt.py from the hand-written docs/llms_intro.md and the nested toctrees (make html llms), and published with the site by the docs job. The introduction was checked claim by claim against the code. AGENTS.md follows ansitable and bdsim: it points assistants that are using pgraph to llms.txt, and records what an agent working on the source needs to know: the layout, the records that must agree, the two staleness flags, the hot Vertex.__setattr__, pickling, the tests and scanners, measuring performance against 0.6.5, and how a release is made. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 26 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
=======================================
Coverage 97.26% 97.26%
=======================================
Files 3 3
Lines 1570 1570
=======================================
Hits 1527 1527
Misses 43 43 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
Follows the pattern of ansitable and bdsim.
llms.txtandllms-full.txtdocs/llms_intro.md: hand-written, the part ofllms.txtthat an assistant that is using pgraph needs: what it is, a quick start, key points, common mistakes. Every claim in it was checked by running code (the quick start prints['a', 'b', 'c'] 12.0; the planners returnNonefor no path;component(c)takes a number; an in-place coordinate edit is not seen by the k-d tree; and so on).docs/llms_txt.py: ansitable's generator, with one change: pgraph's toctree is nested (index→api→common→ sections), so it follows toctrees recursively.llms.txtis the introduction followed by the list of pages;llms-full.txtis the Sphinx site rendered by the text builder, API reference included (13 pages, 175 kB, no raw directives or tracebacks).docs/Makefilehas allmstarget, and the docs job ofci.ymlrunsmake -C docs html llms, so both files are published with the site. Tried locally with exactly that command. The docs job runs only on pushes tomain, so the files appear on the site after this merges.AGENTS.mdPoints assistants that are using pgraph to
llms.txt, and records what an agent working on the source needs: the layout and the oneVertexclass, the records that must agree (validate()), the two staleness flags and why they are separate, whyVertex.__setattr__is hot and what writes__dict__directly, pickling by a flat description, how tests and the scanners (Codacy, Codecov, mypy) behave, that performance claims are measured against 0.6.5, how a release is made, and that scipy must stay out ofpyproject.toml.llms.txtlinks back to it under "Optional".Also: a pointer to both files in the README.
🤖 Generated with Claude Code