test(docs): enforce agent documentation contracts - #1470
Open
s3alfisc wants to merge 3 commits into
Open
Conversation
s3alfisc
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 9 files with indirect coverage changes 🚀 New features to boost your workflow:
|
s3alfisc
force-pushed
the
test/agent-doc-contracts
branch
from
August 30, 2026 23:13
7fc8b74 to
443b68f
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.
Purpose
Add a deterministic, provider-free contract for rendered agent documentation. The standard-library checker verifies the complete
llms.txtinventory, page and fragment links, draft exclusions, path containment, and seven content cases for common PyFixest questions.The checker distinguishes a hosted site from the packaged corpus, where absolute
pyfixest.orglinks intentionally remain remote. It also fixes two pre-existing documentation links exposed by the stricter checks.Stack
Layer 1 of 5 in stack #1475. Base:
master.Generated files
None.
Verification
pixi run docs-renderpixi run -e py312-r pytest tests/test_agent_docs.py -x -q --no-covpixi run -e docs python scripts/check_agent_docs.py --site docs/_siteNo estimator behavior or public Python API changes.