docs(overview): drop 'the five concepts' jargon#13
Merged
Conversation
…t directly
Three places said 'the five concepts (path-to-regexp lineage, ...)' as
if 'the five concepts' were institutional knowledge the reader could
be expected to recognize. A fresh visitor reading those bullets is
left wondering whether this is a famous five.
Rewritten in all three places to describe what the page covers
directly, without using the structural-numbering shorthand:
* docs/index.md → 'what URLPattern is, where it came from
(originally service-worker scope matching at Google), why its
syntax inherits from path-to-regexp instead of inventing something
new, and the cross-runtime adoption arc from incubation in 2019 to
Baseline Newly Available in 2025'
* docs/overview/index.md → 'origin story (URLPattern began as a
service-worker scoping mechanism, not a developer routing toolkit),
why the syntax mirrors path-to-regexp rather than the OpenAPI
{name} style, what *component-wise* matching means in practice,
and the canonicalize-then-match semantics that surprise everyone
porting from substring matching. Ends with three recommended
intros to read before any Python.'
* docs/overview/what-is-urlpattern.md → 'here's what to anchor on
first' (no count). The H2-numbered sections below already
enumerate themselves.
While here, did a fresh-reader sweep for similar patterns. The other
candidate hits (architecture.md 'the three places yarlpattern is
stricter than yarl' in the comparisons pages, 'the four parts index
checks' in the GitHub-URL classifier example, 'the three legitimate
path prefixes' in the YouTube example) all refer to enumerations
that are inline in the immediate context — code blocks or
parentheticals — so they don't demand prior knowledge the way the
'five concepts' framing did. Left those as-is.
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
Three places said "the five concepts (path-to-regexp lineage, ...)" as if those were institutional knowledge the reader could be expected to recognize. A fresh visitor lands on those bullets wondering whether this is a famous five.
Rewritten in all three places (
docs/index.md,docs/overview/index.md,docs/overview/what-is-urlpattern.md) to describe what the content actually covers, without the structural-numbering shorthand.While here, did a wider fresh-reader sweep. Other "the three X" / "the four Y" hits all refer to enumerations that are inline in the immediate context (parentheticals, code blocks), so they don't demand prior knowledge the way "the five concepts" framing did. Left those as-is.
Test plan
grep -rn 'five concepts' docs/returns no matchesjust docsstrict build cleanjust lintall 11 tools pass