Skip to content

Update Get Started docs to Microsoft Style Guide and new installer flow#20

Open
Sachindu-Nethmin wants to merge 1 commit intowso2:devfrom
Sachindu-Nethmin:set-up-and-concepts
Open

Update Get Started docs to Microsoft Style Guide and new installer flow#20
Sachindu-Nethmin wants to merge 1 commit intowso2:devfrom
Sachindu-Nethmin:set-up-and-concepts

Conversation

@Sachindu-Nethmin
Copy link
Contributor

Purpose

The "Get Started" documentation needed to be updated to align with the Microsoft Style Guide (using sentence case for headings, removing unnecessary bolding). Additionally, WSO2 Integrator is now distributed as a standalone application rather than a VS Code extension, requiring updates to the installation and project creation instructions.

Goals

  • Standardize the documentation headings and formatting according to the Microsoft Style Guide.
  • Guide users accurately through the new standalone WSO2 Integrator installer workflow, replacing outdated VS Code extension instructions.

Approach

  • Modified markdown files in en/docs/get-started/ (key-concepts.md, system-requirements.md, install.md, understand-the-ide.md, first-project.md, install-ballerina.md).
  • Converted all markdown headings ( ##, ###) and frontmatter titles to sentence case.
  • Removed bold styling (**) from non-UI elements such as operating system names, generic hardware terms, and inline software prerequisites.
  • Rewrote install.md to instruct users to download the standalone installer directly from the WSO2 website via business email.
  • Revised first-project.md and understand-the-ide.md to remove VS Code Command Palette steps, replacing them with instructions for the standalone WSO2 Integrator IDE application.
  • Adjusted install-ballerina.md to remove automatic VS Code setup details and focus purely on standalone Ballerina installations.

Release note

Updated the "Get Started" documentation to align with the Microsoft Style Guide formatting and to reflect the new standalone application installer experience for WSO2 Integrator.

- Converted markdown headings and frontmatter titles to sentence case across all 'Get Started' pages.
- Removed bold styling from general terms (OS names, hardware, required software) to adhere to Microsoft Style Guide, retaining bold only for UI elements.
- Replaced VS Code extension installation instructions with steps for downloading the standalone installer from the WSO2 website.
- Updated project creation and runtime instructions to reflect the standalone WSO2 Integrator application instead of the VS Code extension workflow.
- Updated documentation references from `VS Code extension` to `WSO2 Integrator IDE`.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 18, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fdf6cc7c-592d-4e0f-84ba-39881fcea571

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

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.

1 participant