Repository navigation
docs: align Hilla/React wording, theme tokens, and terminology in Building Apps and Getting Started - #6337
Merged
Conversation
…lding Apps and Getting Started Fixes #6293. - Describe React views instead of Hilla in the architecture, server push, reactive streams, and consistency pages, and in Getting Started. - State that Building Apps uses Flow views unless stated otherwise, and drop the redundant Flow badges. - Use --vaadin-* base style properties in styling examples, with Aura for theme-specific colors and the Lumo equivalent named alongside. - Define hotswap, live reload, and hot deploy once, and stop claiming hot deploy is enabled automatically. - Move Replace H2 under Persistence with a redirect, fix the Persistence order clash, normalize xref styles, and fill front matter gaps. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Preview DeploymentThis PR has been deployed for preview. URL: https://docs-preview-pr-6337.fly.dev Changed pagesAdded content is highlighted in green; removed content is marked in red on each page.
Built from 81ea310 |
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
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.
Closes #6293.
Four bullets in the issue were already fixed on
mainbefore this PR: the forms meta-descriptions (#6330),package-component.adoc(now recommends--vaadin-*),show-notification.adoc(nowButtonVariant.TERTIARY), anddialogs-and-drawers.adoc(noLumoUtilityleft).Hilla vs React views
callbacks.adoc,futures.adoc, and the AI quick start. The background-jobs overview says which options also work with React views.architecture/layers.adoc,server-push/index.adoc, and the two consistency pages talk about Flow views and React views instead of Flow and Hilla. The diagram already said "Flow UI" and "React UI"; only its alt text changed.interaction/reactive.adoc:TransferTypesPluginmapsFluxbut notMono.com.vaadin.hilla.Nullableimport is noworg.jspecify.annotations.Nullable.@JsonTypeInfoand@JsonSubTypes(its subtypes generator plugin).Lumo vs Aura vs
--vaadin-*Convention: examples use the theme-neutral
--vaadin-*base style properties where they exist. Those don't cover accent colors, semantic colors (success/warning/error), or font sizes. For those, the examples use Aura, the default theme, and name the Lumo equivalent in one sentence.ui-basics/add-styling.adoc: all examples converted. The intro no longer claims the examples are Lumo but work the same with Aura.components/build-component.adoc:--vaadin-gap-xsand Aura status colors, with a note on the Lumo equivalents.components/style-component.adoc: Aura is listed before Lumo and gets an example table like Lumo's.forms-data/add-form/validation.adoc:LumoUtility.TextColor.ERROR, which has no effect under Aura, is replaced with a CSS class and a stylesheet rule.responsive.adoc,css-grid.adoc,create-custom-field, and the PDF page already flag their Lumo assumption, so I left them as they are.Smaller drift
run/index.adocnow defines live reload, hotswap, and hot deploy once, matching the Flow reference, and recommends hotswap.<</...>>and<<{articles}/...>>now use{articles}throughout. Five xrefs lost their.adocsuffix.replace-h2.adocmoved topersistence/replace-h2.adoc(order 7, after Add Flyway), with a redirect. Persistence moved from order 10 to 20, so it no longer clashes with Add a Grid.react/add-view.adocandreact/call-services.adoc, and a page title and meta-description toserver-push/reactive.adoc. Fixed a "use use" typo inthreads.adoc.Verification
npm run check-redirectspasses.Not in this PR
The Getting Started tutorial calls
LumoUtility.BoxShadow.MEDIUMin its drawer listings. That only works with Lumo andLumo.UTILITY_STYLESHEETloaded. The quick start uses the same skeleton and its screenshots show Aura, so the shadow is probably a no-op today. Confirming that needs the real skeleton, so it's left for a separate change.🤖 Generated with Claude Code