Skip to content

docs: codegen for Mix specs and stylers#850

Merged
leoafarias merged 2 commits intomainfrom
docs/update-the-doc-with-code-gen
Feb 6, 2026
Merged

docs: codegen for Mix specs and stylers#850
leoafarias merged 2 commits intomainfrom
docs/update-the-doc-with-code-gen

Conversation

@tilucasoli
Copy link
Collaborator

@tilucasoli tilucasoli commented Feb 6, 2026

Description

Update the 'creating-a-widget' tutorial to demonstrate using mix_annotations code generation. The doc now shows @MixableSpec and @MixableStyler usage, explains @MixableField(setterType: ...) for public setter types, and includes sample generated output (button_spec.g.dart and button_style.g.dart). Also adds instructions to run build_runner and updates the summary/table describing what the developer writes vs. what the generator provides.

Changes

List specific changes made in this PR.

Review Checklist

  • Testing: Have you tested your changes, including unit tests and integration tests for affected code?
  • Breaking Changes: Does this change introduce breaking changes affecting existing code or users?
  • Documentation Updates: Are all relevant documentation files (e.g. README, API docs) updated to reflect the changes in this PR?
  • Website Updates: Is the website containing the updates you make on documentation?

Additional Information (optional)

Is there any additional context or documentation that might be helpful for reviewers?

Update the 'creating-a-widget' tutorial to demonstrate using mix_annotations code generation. The doc now shows @MixableSpec and @MixableStyler usage, explains @MixableField(setterType: ...) for public setter types, and includes sample generated output (button_spec.g.dart and button_style.g.dart). Also adds instructions to run build_runner and updates the summary/table describing what the developer writes vs. what the generator provides.
@docs-page
Copy link

docs-page bot commented Feb 6, 2026

To view this pull requests documentation preview, visit the following URL:

docs.page/btwld/mix~850

Documentation is deployed and generated using docs.page.

@vercel
Copy link
Contributor

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mix-docs Ready Ready Preview, Comment Feb 6, 2026 4:28pm

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 6, 2026
- Replace full generated code blocks with key signatures to reduce
  drift risk as the generator evolves
- Add missing animate/variants/wrap methods to styler generated output
- Add build_runner to the dependency instructions
Copy link
Collaborator

@leoafarias leoafarias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@leoafarias leoafarias merged commit d9c362c into main Feb 6, 2026
5 checks passed
@leoafarias leoafarias deleted the docs/update-the-doc-with-code-gen branch February 6, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants