Update Get Started docs to Microsoft Style Guide and new installer flow#20
Update Get Started docs to Microsoft Style Guide and new installer flow#20Sachindu-Nethmin wants to merge 1 commit intowso2:devfrom
Conversation
- 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`.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment 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. |
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
Approach
en/docs/get-started/(key-concepts.md,system-requirements.md,install.md,understand-the-ide.md,first-project.md,install-ballerina.md).##,###) and frontmatter titles to sentence case.**) from non-UI elements such as operating system names, generic hardware terms, and inline software prerequisites.install.mdto instruct users to download the standalone installer directly from the WSO2 website via business email.first-project.mdandunderstand-the-ide.mdto remove VS Code Command Palette steps, replacing them with instructions for the standalone WSO2 Integrator IDE application.install-ballerina.mdto 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.