docs: split the README reference into a separate user guide - #159
Merged
Conversation
OmarAlJarrah
force-pushed
the
docs/readme-landing-page-and-guide
branch
from
July 20, 2026 18:33
9f0e17e to
7a39d09
Compare
OmarAlJarrah
changed the title
The README had grown into a ~630-line reference manual. Move the deep reference sections into a new docs/GUIDE.md and leave the README with its existing installation, quick-start, and two-models content plus a link list into the guide. Section wording is carried over unchanged. While relocating, fill gaps against the shipped API: - Document the configurable resource limits on ParseOptions and the LimitExceeded / ResourceLimit error. - Add redact(), isDirectory()/hasTrailingSlash(), Url's WHATWG with* aliases, and ParseResult map/fold. - Add sections for three public features the docs never covered: RFC 6570 URI templates, the Kotlin ktx DSL/operators, and the kuri-serde-kotlinx module. - Correct the ValidationError field name (at) and the redact() behavior.
OmarAlJarrah
force-pushed
the
docs/readme-landing-page-and-guide
branch
from
July 20, 2026 18:48
7a39d09 to
bbc63e1
Compare
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.
What & why
The README had grown into a ~630-line reference manual, which pushed the essentials — install, quick start, and the two-models overview — far down the page. This splits the deep reference out into a new
docs/GUIDE.mdand leaves the README with its existing content plus a link list into the guide. The relocated section wording is carried over unchanged.Changes
README.md— keeps the hero, installation, quick start, and the full "Two models, one engine" section as they were, and replaces the deep sections with a "User guide" link list.docs/GUIDE.md(new) — the relocated reference (parsing & errors, building & resolving, utilities, recipes, kuri-bind, standards, conformance, platforms, building from source), plus gaps filled against the shipped API:ParseOptionsand theLimitExceeded/ResourceLimiterror (the docs previously showed onlyallowIpv6ZoneId)redact(),isDirectory()/hasTrailingSlash(),Url's WHATWGwith*aliases, andParseResult.map/foldktxDSL/operators, and thekuri-serde-kotlinxmoduleValidationErrorfield name (at) and the describedredact()behaviorAll example code was verified against the shipped public API, and every README → GUIDE link resolves to a real heading.