Task(4915) - changed syncfusion-codestudio to syncfusion-code - #229
Open
KaviyaSF4835 wants to merge 2 commits into
Open
KaviyaSF4835 wants to merge 2 commits into
KaviyaSF4835 wants to merge 2 commits into
Conversation
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
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.
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/, andide/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:title:anddescription:fields consumed by the docs site for page headings and meta tags."syncfusion code studio features"inoverview.mdandadd-context.md.C:\Program Files\Syncfusion Code Studio), and AppData/Roaming folder paths in troubleshoot guides.Reason for Not Identifying Earlier
platform: 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
platform: syncfusion-code-studiofrontmatter (94 files)sfcodestudio.comURLs (dashboard, models, budget links in 7 files)app.sfcodestudio.com/dashboard). Requires domain/infra confirmation before touching..sfcodestudioconfig path (migrate-code-studio-rules-to-instructions.md)code-studio-ide-toc.html,code-studio-enterprise-server-toc.html)platformkey decision is made.Cofigure(configure-the-code-studio.mdtitle),Desciption(v0.1.0.md),Releted Features(several features pages), and duplicated Checkpoints title/description inmanage-chat-session.md— good candidates for a follow-up docs-cleanup PR.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.
help.syncfusion.com,syncfusion.com/code-studio,app.sfcodestudio.com) remain valid and untouched.tocname:), and image references (srcattributes) are unchanged.Solution Description
Performed a global find-and-replace of the product name in user-facing text across the documentation:
"syncfusion code studio features"→"Syncfusion Code features",syncfusion Code Studio→Syncfusion Codeinagent-plugin.md).platform: syncfusion-code-studiointernal identifiers,sfcodestudio.comlive URLs (except their user-visible link labels, which were updated),.sfcodestudioreal 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
title:frontmatter updated or already correctdescription:fields use "Syncfusion Code"/code-studio/features/...)tocname:)<img src>paths unchangedapp.sfcodestudio.com,help.syncfusion.com,syncfusion.comdestinations intact — only display labels changedplatform:keyConclusion: Safe to merge. All functional identifiers, links, paths, and pipeline keys are preserved. The change is purely presentational branding text for the documentation site.