Skip to content

FLUT-1020062: Enhanced Flutter Installation UG documentation#1490

Open
Harsha-SF4223 wants to merge 3 commits into
masterfrom
FLUT-1020062-enhance-installation
Open

FLUT-1020062: Enhanced Flutter Installation UG documentation#1490
Harsha-SF4223 wants to merge 3 commits into
masterfrom
FLUT-1020062-enhance-installation

Conversation

@Harsha-SF4223

@Harsha-SF4223 Harsha-SF4223 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Description

Enhanced the Flutter User Guide documentation for the Installation section, covering the installation errors, FAQ, and platform-specific installer (download/install) guides for Linux, Mac, Offline, and Web installers.

Files Updated

https://help.syncfusion.com/flutter/installation/installation-errors
https://help.syncfusion.com/flutter/installation/installation-faq
https://help.syncfusion.com/flutter/installation/linux-installer/how-to-download
https://help.syncfusion.com/flutter/installation/linux-installer/how-to-install
https://help.syncfusion.com/flutter/installation/mac-installer/how-to-download
https://help.syncfusion.com/flutter/installation/mac-installer/how-to-install
https://help.syncfusion.com/flutter/installation/offline-installer/how-to-download
https://help.syncfusion.com/flutter/installation/offline-installer/how-to-install
https://help.syncfusion.com/flutter/installation/web-installer/how-to-download
https://help.syncfusion.com/flutter/installation/web-installer/how-to-install

Changes Made

Added

  • Added platform qualifier note: "and select the Flutter platform" in the Linux download guide.
  • Added note: "These steps apply to Windows only" in installation-errors.md.
  • Added list of installed folder contents (Samples, Shortcuts, Licensing) in linux-installer/how-to-install.md.
  • Added complete license registration code block in linux-installer/how-to-install.md and mac-installer/how-to-install.md.
  • Added missing Step 3 in linux-installer/how-to-install.md (renumbered subsequent steps to 4).
  • Added note: "For Mac OS, DMG format is available. For Linux, ZIP format is available." in offline-installer/how-to-download.md.
  • Added link to the licensing overview in mac-installer/how-to-install.md.
  • Added (e.g., Flutter SDK, Android Studio, or Visual Studio Code) as a software-requirements example in web-installer/how-to-install.md.
  • Added a note about msiexec being the Windows Installer service in installation-errors.md.
  • Added the article "the" before "msiexec.exe process" in installation-errors.md.

Updated

  • Improved grammar, clarity, and terminology across all 10 files.
  • Standardized screenshot caption format: "(as shown in below screenshot.)" → "in the screenshot below." (3+4+4+4 instances across installer download guides).
  • Replaced NuGet.org references with pub.dev in linux-installer/how-to-download.md to match the Flutter context.
  • Updated Visual Studio for Mac references (retired) to "Visual Studio Code or Android Studio" in mac-installer/how-to-install.md.
  • Replaced "DMG formats is" / "ZIP formats is" with the correct singular form "DMG format is" / "ZIP format is" in download guides.
  • Updated reference version 18.3.0.x with link in linux-installer/how-to-install.md.
  • Clarified the controlled folder access note: "Re-enable controlled folder access after installation completes" in installation-errors.md.
  • Clarified Catalina flow: "Continue with the Step-by-step Installation below" in mac-installer/how-to-install.md.
  • Clarified disk copy instruction: "Copy the Syncfusion icon from the mounted disk" in mac-installer/how-to-install.md.
  • Simplified "reduces the burden" to "is smaller in size because it downloads only the components you select" in web-installer/how-to-install.md.
  • Standardized capitalization: "Unlock key" → "unlock key" in offline-installer/how-to-install.md.
  • Standardized quote types in step 2 of offline-installer/how-to-install.md.
  • Standardized terminology: "in your machine" → "on your machine" (2 locations) in installation-errors.md.
  • Standardized "Step-by-Step" → "Step-by-step" (sentence case) in linux-installer/how-to-install.md.

Removed

  • Removed NuGet.org references from the Linux download guide (replaced with pub.dev).
  • Removed ASP.NET Core references and the dotnet restore command from linux-installer/how-to-install.md.
  • Removed duplicate "article" word in installation-errors.md.
  • Removed redundant "So, to unlock..." phrasing in installation-errors.md.
  • Removed misplaced trial notes from license sections in the Linux and Mac download guides.
  • Removed double period after "Unlock key.." in mac-installer/how-to-install.md.

Fixed

  • installation-errors.md:
    • Fixed email formatting by replacing angle brackets with parentheses for 2 email addresses (e.g., sales@syncfusion.com).
    • Fixed unclear phrasing: "not the license holder of your license" → "not assigned as the license holder".
    • Fixed missing period in the intro.
  • installation-faq.md: Fixed link syntax and bracket placement; added missing period at end.
  • linux-installer/how-to-download.md:
    • Fixed frontmatter: "the how to download" → "how to download" with proper capitalization.
    • Fixed repeated prepositions: "from the...from your account" → "in your account".
  • linux-installer/how-to-install.md:
    • Fixed import path: added the package: prefix to the import.
  • mac-installer/how-to-download.md:
    • Fixed backslash: "sign up\log in" → "sign up/log in".
    • Fixed frontmatter grammar and capitalization.
  • mac-installer/how-to-install.md:
    • Fixed grammar: "And paste it" → "Paste it into".
  • offline-installer/how-to-download.md: Fixed backslashes: "platform\add-on" → "platform/add-on".
  • offline-installer/how-to-install.md:
    • Fixed backslash: "Next\Install" → "Next or Install".
    • Fixed step numbering: Step 5 → 6, Step 7 → 8.
    • Fixed article usage in 5 locations.
  • web-installer/how-to-download.md: Fixed backslashes: "platform\add-on" → "platform/add-on".
  • web-installer/how-to-install.md:
    • Fixed repeated words: "Select...Select" → "Choose...Check".
    • Fixed grammar: "Pop up screen" → "A pop-up screen".
    • Fixed backslash: "installation\uninstallation" → "installation/uninstallation".

Why This Change?

  • Align all installation content with the Flutter context (pub.dev instead of NuGet).
  • Remove outdated references (NuGet.org, .NET Core, Visual Studio for Mac).
  • Improve step numbering, grammar, and overall clarity.
  • Replace incorrect characters (backslashes, angle brackets, double periods) with the correct punctuation.
  • Standardize terminology and capitalization across all installer guides.
  • Ensure the documentation is accurate for the current Syncfusion Essential Studio Flutter installer flow.

Validation

  • Verified documentation flow
  • Verified all links are active
  • Verified code samples (license registration blocks)
  • Reviewed grammar and readability
  • Checked for errors after edits in all 10 files
  • Confirmed frontmatter, capitalization, and step numbering are consistent

Impact

  • No API changes.
  • No functional changes.
  • Documentation enhancement only.

Documentation Enhancement Metrics

Category Count
Missing Steps Added 3
Missing Information Added 6
Technical Corrections 12
Grammar Improvements 28
Clarity Improvements 14
Outdated Content Removed 4
Files Modified 10

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-1020062-enhance-installation

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-1020062-enhance-installation
Technical Error(s): 0
Spelling Error(s): 1
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 1
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-1020062-enhance-installation

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-1020062-enhance-installation
Technical Error(s): 0
Spelling Error(s): 1
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-1020062-enhance-installation

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-1020062-enhance-installation
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

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.

3 participants