Skip to content

FLUT-1020062: Enhanced Flutter Licensing UG documentation - #1543

Open
Harsha-SF4223 wants to merge 1 commit into
hotfix/hotfix-v34.1.29from
FLUT-1020062-enhance-licensing-hotfix
Open

FLUT-1020062: Enhanced Flutter Licensing UG documentation#1543
Harsha-SF4223 wants to merge 1 commit into
hotfix/hotfix-v34.1.29from
FLUT-1020062-enhance-licensing-hotfix

Conversation

@Harsha-SF4223

Copy link
Copy Markdown
Contributor

Description

Enhanced the Flutter User Guide documentation for the Licensing section, covering the Syncfusion Flutter licensing model, license key registration, and license-vs-unlock-key clarification.

Files Updated

https://help.syncfusion.com/flutter/licensing/overview

Changes Made

Added

  • Added a complete, runnable code example with imports and a MyApp class for SyncfusionLicense.registerLicense(...).
  • Added pubspec.yaml dependency example for syncfusion_flutter_core.
  • Added link to the license key generation help page.
  • Added a step-by-step numbered list (4 steps) to walk through license registration.
  • Added explanation: "pub.dev package-based licensing".
  • Added note: "Applies to both trial and licensed usage".
  • Added note: "License key is platform/version-specific".
  • Added a new section: "License key vs. Unlock key".
  • Added a "See Also" section with 3 relevant links.

Updated

  • Updated frontmatter title to "Syncfusion Licensing Overview" (removed "unlock keys" mention).
  • Updated frontmatter description to focus on the licensing model introduced in 18.3.0.x.
  • Improved clarity, grammar, and terminology throughout the page.
  • Renamed the section to introduce the concept before the steps.
  • Clarified terminology: "License key" vs. "Unlock key" usage scenarios.
  • Improved code example to be copy-paste ready and self-contained.

Removed

  • Removed incorrect return keyword from the runApp() call.
  • Removed redundant "Flutter" repetition in the page intro.
  • Removed the awkward phrase "follow the following".
  • Removed the informal "example" wording (replaced with "application").

Fixed

  • Fixed code: return runApp(MyApp())runApp(const MyApp()).
  • Fixed curly quotes to straight quotes in Dart imports.
  • Fixed double quotes to single quotes inside Dart code blocks.
  • Fixed {% highlight Dart %}{% highlight dart %} (lowercase language tag).
  • Fixed capitalization: "The License key" → "License key".
  • Added missing periods in 3 locations.
  • Fixed grammar: "follow the following" → "follow these steps".

Why This Change?

  • Reflect the new pub.dev package-based licensing model introduced in 18.3.0.x.
  • Eliminate the confusion between license keys and unlock keys.
  • Provide a copy-paste-ready code example so developers can register the license with one step.
  • Align terminology and capitalization with Syncfusion documentation standards.
  • Improve developer onboarding and reduce support incidents related to licensing errors.

Validation

  • Verified documentation flow
  • Verified all links are active
  • Verified the code sample compiles and runs (SyncfusionLicense.registerLicense is called before runApp)
  • Verified pubspec.yaml snippet matches current package name
  • Reviewed grammar, capitalization, and punctuation
  • Checked for errors after edits

Impact

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

Documentation Enhancement Metrics

Category Count
Missing Steps Added 4
Missing Information Added 6
Technical Corrections 3
Code Quality Fixes 1
Grammar Improvements 6
Files Modified 1

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: FLUT-1020062-enhance-licensing-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: FLUT-1020062-enhance-licensing-hotfix
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.

2 participants