Flow Reference Manual content analysis by Claude Code

[peholmst]

articles/flow Content Analysis

Date: 2026-02-02
Purpose: Identify articles that don't fit the reference documentation pattern and should be migrated

Background

According to CLAUDE.md, articles/flow should contain:

• Vaadin Framework reference documentation
• Technical, code-centric, unopinionated API documentation
• Neutral, factual, complete tone
• Focus on what features exist, what they do, how to use them

Note from CLAUDE.md: "Legacy content exists here from when this contained all framework docs. Old tutorials and how-to content should be migrated to Building Apps."

---

Articles Flagged for Migration

Already Marked for Migration ✅

File	Notes
advanced/server-push.adoc	Contains explicit migration notice pointing to Building Apps section (building-apps/business-logic/background-jobs and building-apps/server-push)

Tutorial/Getting Started Content

These articles teach step-by-step how to accomplish tasks rather than providing reference documentation:

File	Title	Issue
testing/end-to-end/getting-started.adoc	Getting Started with End-to-End Testing	Step-by-step tutorial with setup instructions and test creation walkthrough
testing/ui-unit/getting-started.adoc	Getting Started with UI Unit Testing	Beginner guide on setup and first test creation

Recommendation: Move to articles/getting-started or articles/building-apps

How-To/Setup Guides

These are practical, goal-oriented guides focused on achieving specific outcomes:

File	Title	Issue
integrations/spring/spring-boot.adoc	Spring Boot	"How to Integrate Vaadin with Spring Boot" - integration setup guide
production/production-build.adoc	Production Build	"How to create a production build" - practical setup guide
production/docker.adoc	Docker Deployment	"How to deploy with Docker" - step-by-step deployment
production/spring-boot.adoc	Deploying Spring Boot-Based Applications	"How to deploy" guide with packaging options

Recommendation: Move to articles/building-apps or create dedicated articles/production section

Application Structure (Tutorial-Style) ✅

These describe application patterns rather than framework internals:

File	Title	Issue
application/index.adoc	Application Basics	Introductory guide covering Spring Boot, CDI, and plain Java approaches
application/main-view.adoc	Creating a Main View	"How to create a main view" - pattern-based guide
application/routing-navigation.adoc	Basic Routing & Navigation	Tutorial-style routing introduction

Recommendation: Review for overlap with articles/getting-started; consider migration to articles/building-apps

Component Creation Tutorial ✅

File	Title	Issue
component-internals/web-components/an-in-project-web-component.adoc	In-Project Component	Step-by-step component creation tutorial

Recommendation: Move to articles/building-apps

Configuration Guides (Borderline)

These have "how-to" characteristics but may be acceptable as configuration reference:

File	Title	Notes
configuration/development-mode/index.adoc	Development Mode	"How to configure development mode" - setup focused
configuration/live-reload/index.adoc	Hot Deploy & Live Reload	"How to enable live reload" - configuration guide

Recommendation: Review; may be acceptable as configuration reference or could move to development workflow guides

---

Articles That Fit Reference Documentation Pattern

These are properly categorized and contain neutral, technical reference information:

• routing/route.adoc - API reference for @Route annotation
• routing/index.adoc - Feature overview without opinionated guidance
• binding-data/components-binder.adoc - Technical API documentation
• binding-data/index.adoc - Feature reference
• component-internals/index.adoc - Technical reference
• component-internals/web-components/introduction-to-webcomponents.adoc - Specs and concepts
• configuration/maven.adoc - Technical configuration reference
• configuration/properties.adoc - Configuration properties reference
• advanced/ (most items) - Technical features reference
• security/ - Security features reference

---

Summary

Total articles identified for potential migration: ~10-12

Priority Recommendations

1. Immediate: Complete migration of advanced/server-push.adoc (already flagged)
2. High Priority: Move testing "Getting Started" articles
3. Medium Priority: Consolidate production/deployment content in articles/building-apps
4. Review: Evaluate application/ folder for overlap with getting-started content

Migration Targets

Source Content	Suggested Destination
Testing getting-started guides	articles/building-apps or articles/getting-started
Production/deployment guides	articles/building-apps (deployment section)
Spring Boot integration	articles/building-apps
Application basics/patterns	articles/getting-started or articles/building-apps
Component creation tutorials	articles/building-apps