docs: add a Modules overview and Features section to the README - #160
Merged
Conversation
The README only documented the core kuri artifact; the optional kuri-bind and kuri-serde-kotlinx modules were discoverable only by scrolling into the guide. Add a short Modules section after Installation that lists all three artifacts — what each does, its platform coverage, and how to depend on it — so the optional add-ons are visible up front.
Building on the new Modules section, add a Highlights section that shows kuri's capabilities with short, concrete examples: the parse/edit/rebuild builder round-trip, the optional Kotlin operator DSL, RFC 6570 URI templates, annotation binding with kuri-bind, and type-safe query decoding with kuri-serde-kotlinx. This gives each optional module a snippet on the landing page and surfaces features that were previously only in the guide.
OmarAlJarrah
changed the title
Rename the section from Highlights to Features and rewrite each lead-in to be precise and technical — naming the actual packages (org.dexpace.kuri.ktx), types (ParseResult, UriTemplate, QueryParametersFormat), RFC levels, and mechanisms rather than casual phrasing. Add non-throwing parse and structured query editing to the set, and drop the now-duplicated parse note from the quick start.
OmarAlJarrah
changed the title
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 documented only the core
kuriartifact and showed only basic parsing. This surfaces the full module ecosystem and kuri's features on the landing page, in technical terms, so a reader doesn't have to dig into the guide to discover them.Changes
Modules — a new section after Installation listing all three artifacts under
org.dexpace:kuri— the core engine (KMP: JVM, Android, JS, Wasm, native)kuri-bind— annotation binding, JVM-onlykuri-serde-kotlinx— a kotlinx.serialization bridge (same targets askuri, minus Android)Each entry gives what the module does, its platform coverage, and a link to the relevant guide section, followed by a Gradle snippet for the optional modules.
Features — a new section with short, technical examples naming the actual packages, types, and mechanisms:
ParseResultURLSearchParams-style query editingorg.dexpace.kuri.ktx)UriTemplate)kuri-bindkuri-serde-kotlinx)All examples were verified against the shipped public API, and every guide link resolves. Prose + code, no tables.