Repository navigation
Restructure the README - #46
Merged
Merged
Conversation
…nd scannable tables.
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.
The README opened with a long paragraph about dependency pins and kept the main visual and the reasons to use the project far down a 343-line page. This restructures it so the first screen says what the project does and why to use it, and the rest scans as tables.
flow.gifmoved up as the hero image.DataLoader. Unlike the previous examples, which were all skipped, it runs underpytest-codeblocksin CI.streaming/base/storage/download.py) and for compatibility (supported ranges next to what CI checks).Only HTML that PyPI keeps is used (tables,
<details>,<img>,<div align>), and all images use absolute URLs. The jump links target the heading ids GitHub and PyPI generate.Checked:
pytest README.mdgives 1 passed (the quick start) and 6 skipped; the pre-commit hooks pass;twine check --strictpasses on a built wheel; on the pushed branch, GitHub renders all 6 collapsible sections and 6 tables, and every jump link resolves to its section. The PyPI page changes with the next release.