Repository navigation
Move the README's docs into docs/, and keep a short README - #223
Merged
Merged
Conversation
…hort README The website builds drivine.org/py from docs/. design.md and the two Oracle crash notes stay where they are, linked from code and from upstream reports; the import reads only 00-introduction.md and the NN-*.md pages.
# Conflicts: # README.md
Merged
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's docs move into
docs/, one file per##section, and the README becomes a short one that stands alone on PyPI. drivine.org/py is built fromdocs/once drivine'simport-readmes.mjsreads it, and until then it still reads README.md, so the PRs can merge in any order.docs/00-introduction.mdtodocs/14-license.md: the old README's text, verbatim. Anchor links between pages point at the page that holds the anchor now, and repository links are relative todocs/.docs/README.md: an index for GitHub.README.md: the title, badges, a few lines on what it is, install, a short quick start, and links. Every link is absolute, so the page works on PyPI (readme = "README.md";uv buildbuilds, and the wheel's metadata has the new README).docs/design.mdand the two Oracle crash notes stay where they are. Code comments and upstream bug reports link to them. The site import reads only00-introduction.mdand theNN-*.mdpages, so it skips them.Repointed:
sample/README.md's link to the model file, and two test comments that said "as the README says".tests/docs/test_readme.pynow runs the Python blocks from the docs pages, and adds a test that runs the new README's quick start.scripts/release_version.py'sREFERENCESnow also moves the "0.3 is an alpha release" line indocs/00-introduction.md, beside the short README's, so each release keeps both current. Its tests, RELEASING.md and Prepare release's comment say so.Check
Joining
00-introduction.mdand theNN-*.mdpages in order, with one newline between files, and undoing the link rewrites (NN-slug.md#a→#a,../x→x):This is against the README on main after the 0.3.0 release, whose "0.3 is an alpha release" is now in
docs/00-introduction.mdand the short README.Gate
ruff checkandruff format --check: clean.pyright: 0 errors.scripts/unasync.py --check: passes.pytest tests/unit -q: 760 passed.uv build: builds the sdist and the wheel.The tests in
tests/docsneed a database, so they weren't run locally. CI runs them.Fixes #226