chore: prepare for 1.0 release (docs overhaul + remove deprecated APIs)#119
Merged
Conversation
BREAKING CHANGE: removes members that were deprecated in earlier betas. - Remove StringSchema.enumString() and .literal() instance methods; use the Ack.enumString() / Ack.literal() factories. - Remove the MapValue typedef; use JsonMap. - Mark CodecSchema.inputSchema/outputSchema and wrapPropertyConversion @internal so they leave the public surface.
- Rework the site for developer experience: task-first Overview and Quickstart, a warmer narrative voice, and a learning-ordered sidebar (Essentials / How-To / Advanced / Package Authors). - Add a Codecs guide and a tested codecs example. - Validate snippets against the implementation and fix inaccuracies (string length(), SchemaResult methods, SchemaEncodeError, @AckType(name:), constrain/Validator, build flags, error.path). - Cut cross-page duplication; add code-generation and codecs coverage to the README and llms.txt.
- Configuration: replace duplicated custom-validation and @AckType examples with links. - Installation: add an opener, trim the quickstart-duplicating Basic usage section, fix the generator link. - JSON Schema Integration: lead with the value; group the adapter-author note beside the adapter model. - Common Recipes: add forward links to Codecs and JSON Schema Integration.
|
To preview the documentation for this pull request, visit the following URL:
|
docs.page renders .mdx pages but not .md, so links/sidebar entries to the .md schema-converter guides resolved to missing pages. - Drop the 'For Package Authors' sidebar group (the two guides are .md templates with <Target> placeholders that MDX can't render). - Point the JSON Schema Integration adapter note at the GitHub-rendered guide. The guides remain in docs/guides for contributors. Verified with 'npx @docs.page/cli check'.
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
Prepares the
ackecosystem for its 1.0 release: removes deprecated APIs and overhauls the documentation site, README, andllms.txtfor accuracy and developer experience. Every code snippet was validated against the implementation; the full test suite anddart analyzeare green.Breaking changes
Removes members that were deprecated in earlier betas (the pre-1.0 window):
StringSchema.enumString()/StringSchema.literal()instance methods → use theAck.enumString(...)/Ack.literal(...)factories.MapValuetypedef → useJsonMap. (Internal-only — it was never exported, so no impact on consumers.)CodecSchema.inputSchema/outputSchemaand thewrapPropertyConversionhelper are now@internal(off the public surface).Documentation & site
example/lib/codecs_example.dart.llms.txtnow cover code generation (@AckType) and codecs; the README package list is complete.string().length(),SchemaResult.map/match/ifOk/ifFail,SchemaEncodeError,@AckType(name:),constrainrequiringValidator, build flags,error.path).Validation
dart analyze(all packages + example): clean.docs.jsonvalid.Not included (release-cut steps)
1.0.0-beta.12 → 1.0.0viamelos version(alsodocs.jsonversion/isPrereleaseandllms.txt).CONTRIBUTING.md(referenced by the README and a guide).