docs: streamline README and centralize documentation index - #24
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
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
Streamline the public README after the human-facing compatibility cleanup and make
docs/README.mdthe single documentation index.Changes
Stable contractsandCurrent limitationsprose where the compatibility table already communicates the user-visible boundary.IMPORTANTalert.docs/README.mdas the canonical index for architecture, APIs, compatibility evidence, HIR, provenance, and maintainer references.Impact
A new OverPy developer gets the project overview and current support directly from the root README, while maintainers still have direct access to the existing detailed contracts and machine-readable evidence through the docs index.
No compatibility implementation, support-matrix state, corpus evidence, or repository ownership boundary is changed.
Validation
mainand is not behind it.docs/README.mdlinks only to existing documentation/evidence paths.