docs(v0): in-repo doc/ reference ported from the legacy site#91
Conversation
Port the legacy 0.0.x installation, theme-binding, and core-concept docs (dark mode, responsive design, state-based styling, utility-first) into the 1.0.x doc-system format, faithful to the v0 static WindTheme API.
Document the v0 static-setter theming API (addColor/setFontSize/setRoundedSize/setShadowSize/setPixelFactor/wColor) across colors, fonts, spacing scales, and pixel factor.
Constructor and Props for WContainer, WCard, WFlex, WFlexContainer, WFlexible, WText, read from the v0 component sources.
Font size/style/weight, letter spacing, line height, text align/color/decoration/transform, verified against the v0 typography parsers.
align-items, alignment, axis-sizes, flex-direction, flex-fit, flex-x, gap, justify-content, verified against flex_parser and alignment_parser.
Display/overflow, width/height/min-max, padding/margin, background/border/shadow, and the product-grid example.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds 33 new markdown documentation files under doc/ (plus a CHANGELOG.md entry and a .ac/ gitignore addition), porting the legacy v0 web documentation into the repo so the website can sync v0 docs from the branch. No source code under lib/ or example/lib/ is changed.
Changes:
- Adds in-repo
doc/reference for the frozen0.0.xline covering getting-started, concepts, customization, widgets, typography, flex, spacing, sizing, backgrounds, borders, effects, layout, and example topics. - Adds a CHANGELOG
[Unreleased]entry documenting the new docs. - Ignores
.ac/in.gitignore.
Reviewed changes
Copilot reviewed 53 out of 54 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/widgets/{wcard,wcontainer,wflex,wflexcontainer,wflexible,wtext}.md | Widget reference pages with Constructor/Props tables |
| doc/typography/{font-size,font-weight,font-style,line-height,letter-spacing,text-align,text-color,text-decoration,text-transform}.md | Typography utility references |
| doc/customization/{colors,font-family,font-size,font-weight,letter-spacing,line-height,pixel-factor,rounded-corners,shadows}.md | Runtime theme customization pages |
| doc/concepts/{dark-mode,responsive-design,state-based-styling,utility-first}.md | Conceptual overviews |
| doc/flex/{align-items,alignment,axis-sizes,flex-direction,flex-fit,flex-x,gap,justify-content}.md | Flex utilities |
| doc/spacing/{margin,padding}.md, doc/sizing/{width,height,max-width-min-width,max-height-min-height}.md | Spacing and sizing utilities |
| doc/borders/{border-color,border-radius,border-width}.md, doc/backgrounds/background-color.md, doc/effects/shadow.md | Borders, backgrounds, effects |
| doc/layout/{display,overflow}.md, doc/getting-started/{installation,binding-the-flutter-theme}.md, doc/example/product-grid.md | Layout, getting-started, example walkthrough |
| CHANGELOG.md | Unreleased entry documenting the new docs |
| .gitignore | Adds .ac/ |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- customization/font-size: use text-* (not font-*) for font-size utilities; font-* is font weight - font-size/rounded-corners: state the rem factor as 16 (pixelFactor x 4), one multiplication, consistent with pixel-factor.md - wflexible/wflexcontainer: clarify flex fallback wording; axis-min/axis-max instead of axis-* - shadow/border-width/border-radius: single-bracket arbitrary-value placeholder [<value>]
|
Thanks @copilot. Addressed in 0c652e7: Fixed (8):
Declined (2), with source evidence:
|
What
Adds an in-repo
doc/reference to the frozen0.0.xline, porting the legacy site documentation (wind.fluttersdk.com/resources/contents/docs/0.0.3) into the 1.0.x doc-system format. 52 markdown files, mirroring the 0.0.3 topic taxonomy.Why
The 1.0.x line now keeps its docs in-repo under
doc/. This brings the v0 line to the same shape so the website can sync v0 docs from the branch instead of a separate content store.Scope
Docs only. No source under
lib/orexample/lib/is touched. Content is faithful to the v0 API (staticWindThemeclass, widgetsWContainer/WCard/WFlex/WFlexContainer/WFlexible/WText); format mirrors the master 1.0.x doc system (H1, ToC, anchors,<x-preview>, Props/Constructor for widgets, Related Documentation).Layout
getting-started/(2),concepts/(4),customization/(9),widgets/(6)typography/(9),flex/(8),spacing/(2),sizing/(4)backgrounds/(1),borders/(3),effects/(1),layout/(2),example/(1)Guarantees
WDiv,WindThemeData, builder pattern,ring-/grid-cols/animate-,toggleTheme).<x-preview source>resolves to a realexample/lib/pages/**page on this branch; omitted (not faked) where no page exists (getting-started, customization, wcard, min/max sizing)..md; no absolutewind.fluttersdk.comURLs.package:fluttersdk_wind/fluttersdk_wind.dart.Follow-up (not in this PR)
lib/src/parsers/font_style.darthas a trailing-tab typo in a map key ('not-italic\t') that would stop thenot-italicclass from matching at runtime. Documented asnot-italichere; worth a separate v0 source fix.