docs(index): drop README-pointer disclaimer + add Install + new First-match#12
Merged
Conversation
…isclaimer
The previous docs/index.md disclaimed itself as a work in progress
and pointed readers back to the GitHub README for installation,
the engine-pluggability story, and the conformance matrix. With
phases 1-9 of the docs work landed, none of that is true anymore:
* installation lives here (this commit adds it),
* engine pluggability is explained in Examples + Architecture,
* the conformance matrix is the WPT Conformance page,
* comparisons live in their own section.
Rewritten home page:
* Lead with the same 100%-conformance / 469 / 469 BLUF as the
README so first impressions match across surfaces.
* New Install section. Two lines: pip install yarlpattern (stdlib
re, 99.5% conformance) or pip install 'yarlpattern[regex]' for
the JS v-flag set-ops that close the last 2 of 366 data-corpus
cases. One sentence on why the gap exists.
* New First match example: cross-component URLPattern({hostname,
pathname}) extracting tenant + version + tail in one .exec()
call. Same example shape as the README's lede so a reader
arriving from either surface sees the same pattern. Tested
against the real library before committing.
* New 'Where to go next' section: a six-bullet directory of the
rest of the site (Overview / Examples / Reference / Comparisons
/ WPT Conformance), replacing the README-pointer block.
The pre-existing .pathname.groups attribute access pattern is also
fixed in the example — the correct accessor is .pathname['groups']
(dict, not attribute).
github-actions
Bot
added
the
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
The docs/index.md still said "This site is a work in progress. For the moment, the project README is the most complete reference: installation, the engine-pluggability story, the WHATWG conformance matrix, and the comparisons with other Python routers."
After phases 1-9, every claim in that sentence is no longer true:
New home page
redefault +[regex]extra for full conformance)Also fixes a stale
.pathname.groups(attribute) access to.pathname['groups'](dict).Test plan
uv run python -c '...'confirms the new example's three asserts all passjust docsstrict build cleanjust lintall 11 tools pass