docs: prefer enumValues over enumString for Dart enums#81
Merged
leoafarias merged 1 commit intomainfrom Feb 25, 2026
Merged
Conversation
- Reorder enum schema listings to show enumValues first across all docs - Update examples to use Ack.enumValues with Dart enums instead of enumString - Clarify that enumString is for ad-hoc string lists without backing enums - Update @AckModel examples to use Dart enum fields (which auto-generate enumValues) - Consolidate preference guidance to api-reference and llms.txt to avoid repetition - Apply Diataxis principles: reference describes, how-to guides show by example
|
To view this pull requests documentation preview, visit the following URL: Documentation is deployed and generated using docs.page. |
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.
Updated documentation to prefer Ack.enumValues() when a Dart enum exists, providing type safety and richer parsing. Reordered examples, clarified enumString usage for ad-hoc lists only, and consolidated guidance per Diataxis principles.