release(v0.7.3): hand-maintained README-pypi.md for proper PyPI rendering#66
Merged
Conversation
…ring PyPI doesn't resolve relative image paths or cross-links against the source repo, so https://pypi.org/project/aicertify/ has been silently showing broken images (hero banner, diagram1, demo.gif) and broken links into examples/ and docs/. This release adds a hand-maintained README-pypi.md and points the `readme` field in pyproject.toml at it. The new file is a slightly- trimmed variant of README.md — same structure (banner → tagline → badges → diagram → quick start → demo gif → minimal Python → why → comparison table → OPA-users section → examples → see-the-output → GitHub pointers → license) — but with every image and cross-link rewritten to absolute `https://raw.githubusercontent.com/...` or `https://github.com/...` URLs. Trimmed sections vs the GitHub README: the language switcher (PyPI audience is en-only), the verbose How-It-Works/architecture diagram walkthrough (replaced with a single-paragraph OPA-users section), the long Regulatory Coverage list (replaced with the comparison table + a link to the full list), the CLI flag reference table (full help is one `aicertify --help` away), Status / Who-should-contribute (less PyPI-relevant). All trimmed content lives one click away on GitHub via the explicit "More on GitHub" pointer near the end. Verified locally with `readme_renderer[md]` (the actual library PyPI uses) — all image URLs resolve to https://raw.githubusercontent.com, all hrefs resolve to https://github.com or other absolute targets. The GitHub README.md is unchanged. Maintenance pattern: when updating Quick Start, the comparison table, or the examples list in README.md, update README-pypi.md in lockstep. CHANGELOG drift is the only thing to watch for. No code changes in this release.
github-actions
Bot
added
📝 documentation
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.
Summary
PyPI doesn't resolve relative image paths or cross-links against the source repo, so https://pypi.org/project/aicertify/ has been silently showing broken images (hero banner, diagram1, demo.gif) and broken links into `examples/` and `docs/`.
This release adds a hand-maintained `README-pypi.md` and points the `readme` field in `pyproject.toml` at it. Same shape as the GitHub README but with every image and cross-link rewritten to absolute `https://raw.githubusercontent.com/.../...\` or `https://github.com/.../...\` URLs.
The GitHub README.md is unchanged. This is purely a PyPI-listing-presentation fix.
Trimmed vs. GitHub README
All trimmed content is one click away via the explicit "More on GitHub" pointer.
Verification
Maintenance pattern
When updating Quick Start, comparison table, examples list, or any newly-relative paths in README.md → update README-pypi.md in lockstep. Drift surface is small (well under half the size of README.md).
Test plan