Skip to content

Update Overview & Architecture with new content and MS Style Guide#16

Open
Sachindu-Nethmin wants to merge 1 commit intowso2:devfrom
Sachindu-Nethmin:overview-
Open

Update Overview & Architecture with new content and MS Style Guide#16
Sachindu-Nethmin wants to merge 1 commit intowso2:devfrom
Sachindu-Nethmin:overview-

Conversation

@Sachindu-Nethmin
Copy link
Contributor

Purpose

Update "Overview & Architecture" page. This PR updates it with the current product value proposition, a high-level architecture diagram, and refined formatting to capture the "low-code simplicity, pro-code power" message.

Goals

  • Provide a clear summary of product capabilities and deployment flexibility.
  • Introduce a visual architecture diagram for better conceptual understanding.
  • Standardize the page formatting according to the Microsoft Style Guide.

Approach

  • Content Update: Rewrote the introduction to emphasize the value proposition: "Connect Anything, and Solve any Integration Challenge."
  • Visuals: Added the architecture diagram using the Docusaurus @site alias for stable asset pathing.
  • Style Guide Compliance:
    • Converted all L2 and L3 headers to sentence case.
    • Used plain text labels with colons for list terms, strictly reserving bold for UI elements.
    • Removed redundant marketing phrases in favor of direct, technical language.

Release note

Updated the "Overview & Architecture" guide with refreshed product content, a high-level architecture diagram, and standardized formatting compliant with the Microsoft Style Guide.

Automation tests

  • Manual Verification: Verified the markdown rendering locally to ensure headers, lists, and the architecture diagram path are correctly resolved and visually consistent.

Security checks

  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets: Yes

Test environment

  • Tested on Linux using the Docusaurus development server.
Screencast.from.2026-03-17.13-22-57.webm

- Integrate core product value proposition and "Run it your way" deployment options.
- Add high-level architecture diagram and associated image assets.
- Align formatting with Microsoft Style Guide (sentence-case headings, no non-UI bolding).
- Standardize list separators to colons for improved readability and consistency.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 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: 834e090e-d9e6-4455-8520-e2b30e0f5886

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 TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.


## Low-code / pro-code duality

This is the key differentiator. Every integration can be built two ways, and both stay in sync:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L19 mention about three ways including AI assistance as well this line confuse first time readers

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the vscode symbol from the WSO2 Integration Platform Tooling replace it with current WSO2 integrator icon

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