docs: improve project documentation#128
Merged
Merged
Conversation
|
To preview the documentation for this pull request, visit the following URL:
|
leoafarias
marked this pull request as ready for review
July 15, 2026 12:47
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.
Summary
Why
Several examples had drifted from Ack's strict runtime semantics, including unanchored full-value patterns, integer inputs shown for double schemas, and a UTC value shown for the local-date codec. The JSON serialization page covered decoding but not the outbound encoding path, and two adapter guides were not part of the rendered documentation navigation. Existing documentation tests also reproduced corrected snippets without checking the literal source, allowing those differences to go unnoticed.
These updates make the documentation safer to copy, easier to navigate, and more complete for users and contributors.
Validation
npx @docs.page/cli checkdart test test/documentation --reporter=expanded— 137 tests passeddart run melos run analyze --no-select— all 6 packages passedgit diff --check