Skip to content

Task(4915) - changed syncfusion-codestudio to syncfusion-code - #229

Open
KaviyaSF4835 wants to merge 2 commits into
developmentfrom
renaming-change
Open

KaviyaSF4835 wants to merge 2 commits into
developmentfrom
renaming-change

Conversation

@KaviyaSF4835

Copy link
Copy Markdown
Collaborator

Bug Description

The documentation references the product by its previous branding, "Syncfusion Code Studio", throughout all content — including page titles, frontmatter descriptions, body prose, installation paths, prerequisites, UI instructions, and cross-reference link text. This is inconsistent with the product's official name, "Syncfusion Code".

Impact: Users see an outdated brand name in user-facing documentation (titles, SEO descriptions, keywords, navigation instructions), causing brand inconsistency across the docs site, search result listings, and linked pages.

Scope: 45+ markdown files across all sections — README.md, enterprise-server/, ide/customization/, ide/features/, ide/getting-started/, ide/how-to-guides/, ide/language-setup/, ide/release-notes/, ide/troubleshoot/, and ide/tutorials/.


Root Cause

The docs repository predates the branding change. All documentation was originally authored when the product name was "Syncfusion Code Studio". When the product was renamed to "Syncfusion Code", the docs repository naming conventions (frontmatter title, description, prose, UI navigation steps) were not updated in sync, leaving the legacy brand name embedded across:

  1. Frontmattertitle: and description: fields consumed by the docs site for page headings and meta tags.
  2. Keywords — keyword strings like "syncfusion code studio features" in overview.md and add-context.md.
  3. Prose content — feature overviews, prerequisites, step-by-step instructions ("Open Syncfusion Code Studio…").
  4. OS-level instructions — Start Menu / Applications names, install paths (C:\Program Files\Syncfusion Code Studio), and AppData/Roaming folder paths in troubleshoot guides.
  5. Cross-reference link text — "Refer to [Syncfusion Code Studio Install and Configure]…" style references.

Reason for Not Identifying Earlier

  • Purely textual, non-functional change — the legacy name rendered correctly and broke no builds, links, or images, so it passed through reviews and linting without flags.
  • No automated branding-consistency check exists in the repo (no lint rule / CI step verifying product naming in frontmatter or prose).
  • High file saturation — "Syncfusion Code Studio" appeared in virtually every file, making it read as the "correct" name during individual PR reviews; the inconsistency only becomes visible when a branding decision mandates a global comparison.
  • Frontmatter vs. prose treated as separate concernsplatform: syncfusion-code-studio (an internal platform identifier) was intentionally left unchanged, which visually masked the prose-level staleness during casual reviews.

Related Areas Needing Address

Area Status / Recommendation
platform: syncfusion-code-studio frontmatter (94 files) Intentionally not changed — internal platform identifier/toc key, not user-facing prose. Confirm with the docs platform team whether this key should be renamed in a separate, coordinated change, since the TOC pipeline likely depends on it.
sfcodestudio.com URLs (dashboard, models, budget links in 7 files) Not changed — live hostnames (e.g., app.sfcodestudio.com/dashboard). Requires domain/infra confirmation before touching.
.sfcodestudio config path (migrate-code-studio-rules-to-instructions.md) Not changed — actual on-disk folder name; must match reality. Rename only if the app itself renames the directory.
TOC files (code-studio-ide-toc.html, code-studio-enterprise-server-toc.html) Filenames and internal structure need a follow-up check once the platform key decision is made.
Pre-existing typos carried over Cofigure (configure-the-code-studio.md title), Desciption (v0.1.0.md), Releted Features (several features pages), and duplicated Checkpoints title/description in manage-chat-session.md — good candidates for a follow-up docs-cleanup PR.
Images / screenshots Old screenshots may still show "Syncfusion Code Studio" UI in feature-images/, gettingstarted-images/, etc. — need a design/UX pass to confirm if captures require retaking.

Is it a Breaking Issue?

No — this is a non-breaking, documentation-only change.

  • No code, APIs, configs, schemas, or build outputs are affected.
  • All URLs and file paths referenced in live links (help.syncfusion.com, syncfusion.com/code-studio, app.sfcodestudio.com) remain valid and untouched.
  • Internal anchors, TOC references (tocname:), and image references (src attributes) are unchanged.
  • The only visible difference is display text in titles, descriptions, and prose.

Solution Description

Performed a global find-and-replace of the product name in user-facing text across the documentation:

  1. Prose replacement — every occurrence of "Syncfusion Code Studio" in headings, paragraphs, steps, notes, and link text changed to "Syncfusion Code" (45+ files).
  2. Frontmatter titles/descriptions — updated in all affected pages so rendered page titles and meta descriptions reflect the new brand.
  3. Keywords — keyword lists updated where the brand name was embedded (e.g., "syncfusion code studio features""Syncfusion Code features", syncfusion Code StudioSyncfusion Code in agent-plugin.md).
  4. OS/system paths & install instructions — updated Start Menu / Finder application names, Program Files / AppData / ~/Library paths in troubleshoot and installation guides to match the rebranded application.
  5. Deliberately excluded (to avoid breaking):
    • platform: syncfusion-code-studio internal identifiers,
    • sfcodestudio.com live URLs (except their user-visible link labels, which were updated),
    • .sfcodestudio real config folder paths.

Verification: Workspace-wide search post-change returns zero remaining occurrences of "Syncfusion Code Studio" in prose — only the intentional platform: keys and live URL hostnames remain.


Breaking Change Validation Report

Check Result Notes
Rendered page titles match new brand ✅ Pass All title: frontmatter updated or already correct
Meta descriptions ✅ Pass All description: fields use "Syncfusion Code"
Internal doc links (/code-studio/features/...) ✅ Pass Link targets are path-based, untouched — no broken links
TOC entries (tocname:) ✅ Pass Unchanged values kept intact — no pipeline impact
Image references ✅ Pass All <img src> paths unchanged
Live external URLs ✅ Pass app.sfcodestudio.com, help.syncfusion.com, syncfusion.com destinations intact — only display labels changed
Frontmatter platform: key ✅ Pass Unchanged by design — no pipeline impact
Markdown build / lint ✅ Pass No structural or syntax changes
SEO/keyword consistency ✅ Pass Brand-name keywords updated in affected files
Screenshots brand alignment ⚠️ Deferred Old screenshots may show legacy UI — needs separate visual asset review

Conclusion: Safe to merge. All functional identifiers, links, paths, and pipeline keys are preserved. The change is purely presentational branding text for the documentation site.

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