Skip to content

docs: improve project documentation#128

Merged
leoafarias merged 1 commit into
mainfrom
chore/documentation-updates
Jul 15, 2026
Merged

docs: improve project documentation#128
leoafarias merged 1 commit into
mainfrom
chore/documentation-updates

Conversation

@leoafarias

Copy link
Copy Markdown
Member

Summary

  • correct misleading validation, JSON serialization, JSON Schema, API response, and date-codec examples
  • expand configuration guidance and clarify the quickstart and API reference flow
  • publish the adapter-authoring guides as navigable MDX pages
  • add code of conduct, security, and support documentation
  • add source-integrity coverage so tested snippets cannot silently diverge from the documentation

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 check
  • dart test test/documentation --reporter=expanded — 137 tests passed
  • dart run melos run analyze --no-select — all 6 packages passed
  • browser verification across all 17 documentation routes at 1440×900 and 390×844
  • Dart formatting and git diff --check

@docs-page

docs-page Bot commented Jul 15, 2026

Copy link
Copy Markdown

To preview the documentation for this pull request, visit the following URL:

docs.page/btwld/ack~128

Documentation is deployed and generated using docs.page

@leoafarias
leoafarias marked this pull request as ready for review July 15, 2026 12:47
@leoafarias
leoafarias merged commit 7639b53 into main Jul 15, 2026
3 checks passed
@leoafarias
leoafarias deleted the chore/documentation-updates branch July 15, 2026 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant