Repository navigation
Fix README links for PyPI and GitHub Wiki - #33
Merged
Merged
Conversation
Makiras
added
the
release:patch
ChatGPT Codex Connector
Makiras
marked this pull request as ready for review
October 24, 2026 13:01
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.
README links in the published PyPI description point to repository-relative Markdown paths. Use absolute URLs for both READMEs, link documentation to the actual GitHub Wiki, and add the package Documentation URL. Update installation instructions now that uc-xcomm is available.
Use a consistent six-badge row: PyPI version, declared Python versions, master Python-wheel CI, MulanPSL-2.0, GitHub Wiki, and Stars. The first five badges use flat-square; Stars uses social and links to the repository homepage. All badges use absolute image and destination URLs.
The bilingual Wiki is live at https://github.com/XS-MLVP/xcomm/wiki (Wiki commit f1122ee). Its 50 content pages, Home, sidebar and footer are exported from the repository; page links use full Wiki URLs. Document the separate Wiki push, since documentation CI produces export artifacts.
Validation: four publication-link regression tests pass, all 50 translated pages and 178 local links pass, and strict MkDocs build and the 53-page Wiki export pass. The prior CI sdist verified README metadata and the Wiki project URL. All current README image and destination URLs were checked online, including badge contents. The latest commit only adjusts the two README badge rows; packaging CI is retriggered by the push.
Keep this draft PR unmerged until the maintainer explicitly confirms publication. Merging with release:patch will trigger 1.1.1 and update the PyPI description; 1.1.0 remains unchanged.