Conversation
Expand contractions to full forms, fix grammar errors, and apply style consistency improvements across 75 files in the building-apps documentation section.
Member
|
If we are going to start using "will" again, we should update Vale to not recommend against it. I don't actually know what was wrong with using it in the first place. @jouni do you know? |
Vaadin 25 changed vaadin-dev to opt-in. Update docs to reflect this: - Replace vaadin-dev exclusion pattern with optional dependency pattern - Modernize flow-build-info.json examples (remove legacy fields) - Replace webpack references with Vite in Hilla pages - Update ES5 transpilation references to ES2021 - Update Node/npm version minimums to 16.14/8.3 - Replace flow-server-production-mode and flow-maven-plugin references with vaadin-maven-plugin (except MPR docs) - Add missing build-frontend parameters to Hilla pages
* First human outline * Write Compose with Components how-to article Turn the outline into a full conceptual article teaching component decomposition and communication patterns. Covers view breakdown with an HR app example, component tree visualization, and four communication mechanisms (setters, signals, events, callbacks) organized by data flow direction. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * First human outline of add-images-icons.adoc * Write Add Images and Icons how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * First human outline of add-dialogs-popovers.adoc * Write Add Dialogs and Popovers how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Update copy-paste example to a self-contained view Replace the two separate snippets with a single @route view that includes import statements. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Show a Notification how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Add Styling how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Write HTML how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Arrange with Layouts how-to article Add cross-references to the layout guide from the Compose with Components and Write HTML articles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add SVG diagrams for layout alignment section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Add Keyboard Shortcuts how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add when-to-use guidance to keyboard shortcuts article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Write Add Drag and Drop how-to article Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add metadata to UI Basics section index Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix Vale errors and warnings in UI Basics articles Resolve all 17 errors and 4 warnings reported by Vale across the ui-basics section. Update the spelling vocabulary to accept common technical terms (APIs, UIs, enums, Cmd, droppable, preformatted, Classpath). Fix product name casing (TextField → Text Field, FormLayout → Form Layout), replace e.g. with "for example", rephrase headings to satisfy title case and cliché rules, and remove an absolute docs URL from a code example. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Restructure Add Styling guide to focus on 3 core techniques Slim the guide from ~400 lines to ~180, matching the pattern of peer guides (keyboard shortcuts, drag and drop). Focus on theme variants, inline styles, and CSS class names — ordered so the two pure-Java approaches come first. Move utility classes, component style properties, and other advanced topics to a "Beyond the Basics" section with links to the styling reference. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Replace deprecated PopoverVariant.ARROW with LUMO_ARROW PopoverVariant.ARROW is deprecated since Vaadin 25.0. Use PopoverVariant.LUMO_ARROW instead, which is the correct variant for the Lumo theme used in the documentation examples. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Simplify persistent notifications section with combined example Consolidate three subsections (close buttons, action buttons, keyboard shortcuts) into a single section with one code example. Add keyboard shortcuts (Escape/Enter) to close/action buttons throughout the article for consistency, including the copy-paste example and utility class. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Clarify styling scope by what you're styling and improve SVG dark mode Restructure the "When to Style with What" section in Add Styling to start from what you're styling (components vs HTML elements/layouts), explaining that inline styles don't reach shadow DOM internals. Add a NOTE to the Inline Styles section about this limitation. Update Write HTML and Layouts to mention Div with CSS flexbox/grid as a layout option. Fix SVG diagrams to use prefers-color-scheme media query for dark mode visibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: address PR #5156 review comments for styling and layouts articles - Fix custom properties description: don't call them "constants", mention both Lumo and Aura themes, link to style properties reference pages - Add stylesheet link in CSS Class Names section pointing to stylesheets docs - Add addToStart/addToMiddle/addToEnd methods to HorizontalLayout section - Replace responsiveSteps with autoResponsive mode as primary FormLayout approach Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: remove duplicate custom properties paragraph from CSS Class Names section Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Mikhail Shabarov <61410877+mshabarov@users.noreply.github.com>
Add a practical guide for serving file downloads in Vaadin apps using DownloadHandler, complementing the existing uploads article and the advanced downloads reference. Includes a compilable example view. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Add a section demonstrating how to wrap PDF.js as a Vaadin component using LitElement + @Tag/@NpmPackage/@jsmodule, alongside a comparison table to help readers choose between IFrame and PDF.js. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
…5204) Mention the Component Factory PDF Viewer add-on as a ready-made alternative to building a custom PDF.js viewer. Includes a usage example, a note explaining the Component Factory support model, and an expanded comparison table covering all three viewer options. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add DTOs, SPIs, Modulith, NET to Vale accepted vocabulary - Replace "will" with present tense in factual statements - Fix heading case: "What is a Feature?" -> "What Is a Feature?"
Add colspan, dev, iText, PDFBox, PDFs to fix spelling failures in CI lint check.
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
6 participants
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.
Expand contractions to full forms, fix grammar errors, and apply
style consistency improvements across 75 files in the building-apps
documentation section.