Add AI agent discoverability for practitioner guide#242
Merged
Conversation
Three discovery surfaces updated so agents find the practitioner workflow regardless of how they encounter the library: 1. Package docstring (help(diff_diff)) — now mentions the 8-step practitioner workflow and practitioner_next_steps() 2. README.md — new "For AI Agents" section after Quick Start, pointing to docs/llms.txt and docs/llms-practitioner.txt 3. pyproject.toml — "Practitioner Guide" URL in project metadata, visible on PyPI sidebar Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Overall Assessment ✅ Looks good Executive Summary
Methodology
Code Quality No findings in the changed code. Performance No findings. The PR is documentation/metadata only. Maintainability
Tech Debt
Security No findings. No secrets, credentials, or new execution surfaces are introduced. Documentation/Tests
|
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.
Summary
docs/llms.txtanddocs/llms-practitioner.txthelp(diff_diff)) to mention the 8-step practitioner workflow andpractitioner_next_steps()pyproject.tomlMethodology references (required if estimator / math changes)
Validation
Security / privacy
Generated with Claude Code