Clarify public guides and keep maintenance history internal - #52
Merged
Conversation
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.
The README sent readers to dated validation runs and internal maintenance notes. It now presents the backend party, setup, and supported features in concise, direct language, with the banner and character personalities intact. Linked guides follow the same style and retain concrete limitations.
Maintenance history and detailed research now live under
docs/internal/. Project instructions and the runbook record the documentation policy so future updates preserve it. Absolute README links and the image URL support PyPI rendering; API examples use supported backends and safe lifecycle handling.Validation: 251 tests passed with one existing expected failure; 35 Microsoft Pyright checks passed separately. Pyright, Ruff, wheel/sdist builds, and documentation link/anchor checks passed. No library behavior or dependencies changed.