Skip to content

docs(v0): in-repo doc/ reference ported from the legacy site#91

Merged
anilcancakir merged 8 commits into
v0from
docs/v0-doc-system
May 30, 2026
Merged

docs(v0): in-repo doc/ reference ported from the legacy site#91
anilcancakir merged 8 commits into
v0from
docs/v0-doc-system

Conversation

@anilcancakir
Copy link
Copy Markdown
Collaborator

What

Adds an in-repo doc/ reference to the frozen 0.0.x line, 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/ or example/lib/ is touched. Content is faithful to the v0 API (static WindTheme class, widgets WContainer/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

  • No 1.0-only API leakage (WDiv, WindThemeData, builder pattern, ring-/grid-cols/animate-, toggleTheme).
  • Every <x-preview source> resolves to a real example/lib/pages/** page on this branch; omitted (not faked) where no page exists (getting-started, customization, wcard, min/max sizing).
  • All cross-doc links are relative .md; no absolute wind.fluttersdk.com URLs.
  • Widget Constructor/Props tables read from the actual v0 component sources.
  • v0 color shades 50-900 (no 950); barrel import package:fluttersdk_wind/fluttersdk_wind.dart.

Follow-up (not in this PR)

  • lib/src/parsers/font_style.dart has a trailing-tab typo in a map key ('not-italic\t') that would stop the not-italic class from matching at runtime. Documented as not-italic here; worth a separate v0 source fix.

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.
Copilot AI review requested due to automatic review settings May 30, 2026 17:30
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 30, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 93874c1e-09ce-43c7-945a-95945c09fce6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/v0-doc-system

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 frozen 0.0.x line 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.

Comment thread doc/customization/font-size.md Outdated
Comment thread doc/customization/rounded-corners.md Outdated
Comment thread doc/typography/letter-spacing.md
Comment thread doc/widgets/wflexible.md Outdated
Comment thread doc/widgets/wflexcontainer.md Outdated
Comment thread doc/typography/font-size.md Outdated
Comment thread doc/typography/letter-spacing.md
Comment thread doc/effects/shadow.md
Comment thread doc/borders/border-width.md
Comment thread doc/borders/border-radius.md
- 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>]
@anilcancakir
Copy link
Copy Markdown
Collaborator Author

Thanks @copilot. Addressed in 0c652e7:

Fixed (8):

  • customization/font-size.md: font-size utilities now use text-* (text-xs, text-3xl, text-[8]); font-* is font weight. Verified against lib/src/parsers/font_size_parser.dart:11 (regex matches text-). Added a note disambiguating the two prefixes.
  • typography/font-size.md + customization/rounded-corners.md: formula now reads value × rem factor (16 by default) (one multiplication), matching WindTheme.getRemFactor() (= pixelFactor × 4) and pixel-factor.md. Dropped the misleading × 4 × 4 framing.
  • widgets/wflexible.md: clarified the flex fallback wording ("neither the flex parameter nor a flex-x utility is set").
  • widgets/wflexcontainer.md: mainAxisSize now says axis-min / axis-max instead of axis-*.
  • effects/shadow.md, borders/border-width.md, borders/border-radius.md: arbitrary-value placeholder is now single-bracket [<value>].

Declined (2), with source evidence:

  • typography/letter-spacing.md "Default px" column and the 0.15 × 4 = 0.6px example: the parser does multiply the stored value by the pixel factor. See lib/src/parsers/letter_spacing_parser.dart:18 and :40: letterSpacing = WindTheme.getLetterSpacing(size) * WindTheme.getPixelFactor() (pixel factor = 4 by default). So tracking-tighter (-0.05) → -0.2 logical px is correct, and the customization example is correct. The customization page describes the stored em value; the typography page describes the applied pixel value. Both are accurate, so these are kept as-is.

@anilcancakir anilcancakir merged commit fd0fa60 into v0 May 30, 2026
2 checks passed
@anilcancakir anilcancakir mentioned this pull request May 30, 2026
@anilcancakir anilcancakir deleted the docs/v0-doc-system branch May 30, 2026 17:52
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.

2 participants