Here are the main consistency issues with the current sidebar labels, in order of priority:
1. The current top-level section uses different grammatical forms:
Get Started -> verb phrase,
Develop / Deploy / Manage -> bare verbs
Connectors / AI Integrations / Reference -> nouns
Suggestion: Items at the same nav level must share one form. Two options:
| Current |
Option A (all nouns) |
Option B (all bare verbs) |
Get Started |
Getting Started |
Start |
Develop |
Development |
no change |
Connectors |
no change |
Connect |
AI Integrations |
no change |
Integrate AI |
Guides |
no change |
no clean verb form |
Deploy |
Deployment |
no change |
Manage |
Management |
no change |
Reference |
no change |
no clean verb form |
Preferred: Option A. Five of eight labels are already nouns and need no change. Option B breaks down on Guides and Reference, which have no natural verb equivalents.
2. Items directly under Develop section uses different grammatical forms:
- Create Integrations / Understand the IDE -> verb phrases
- Transform / Test / Debug -> bare verbs
- Integration Artifacts / Tools -> nouns
- Troubleshooting -> gerund
Suggestion: Normalize to one form. Two options:
| Current |
Option A (all nouns) |
Option B (all bare verbs) |
Create Integrations |
Creating Integrations |
Create |
Understand the IDE |
IDE Overview |
Explore |
Integration Artifacts |
no change |
no clean verb form |
Transform |
Transformations |
no change |
WSO2 Integrator Copilot |
no change |
no change |
Test |
Testing |
no change |
Debug |
Debugging |
no change |
Troubleshooting |
no change |
Troubleshoot |
Tools |
no change |
no clean verb form |
Preferred: Option A. Option B breaks down on Integration Artifacts and Tools, which are catalog sections with no natural verb equivalent. Option A keeps those as-is and produces clean, unambiguous names across the board.
3. The top-level section is named Get Started while the equivalent sub-section inside AI Integrations is named Getting Started.
Suggestion: Normalize to Getting Started (gerund form is the industry standard for doc section names).
4. Deploy to WSO2 Cloud and Self-Hosted sections are listed under the same parent, but use opposite forms.
Suggestion: Standardize both to noun phrases: WSO2 Cloud and Self-Hosted.
5. There are several single-item wrapper sections which add unnecessary depth and use vague labels:
Other under Develop → Tools is a single-item wrapper whose only content is the scan tool.
Suggestion: Promote the scan tool directly to the Tools level and drop the wrapper.
Miscellaneous under Reference contains network proxy configuration docs.
Suggestion: Rename it to Network or Environment Setup.
Appendix under Reference is a print convention that reads oddly in web navigation.
Suggestion: Promote its contents (Error Codes, Glossary, FAQ, Release Notes) as flat items directly under Reference and remove the wrapper.
6. Build Your Own and Connector Catalog are listed under Connectors but use opposite forms.
Suggestion: Rename Build Your Own to Custom Connectors.
Proposed structure
Getting Started ← was "Get Started"
├── Concepts
├── Set Up
└── Quick Starts
Development ← was "Develop"
├── Creating Integrations ← was "Create Integrations"
├── IDE Overview ← was "Understand the IDE"
├── Integration Artifacts
│ ├── Integration as API
│ ├── Event-Driven Integration
│ ├── File-Driven Integration
│ └── Other Artifacts
├── Transformations ← was "Transform"
├── WSO2 Integrator Copilot
├── Testing ← was "Test"
├── Debugging ← was "Debug"
├── Troubleshooting
└── Tools
├── Integration Tools
├── Migration Tools
└── Scan Tool ← was under "Other" wrapper
Connectors
├── Connector Catalog
└── Custom Connectors ← was "Build Your Own"
AI Integrations
├── Getting Started
├── Develop AI Applications
│ ├── Direct LLM Calls
│ ├── RAG
│ ├── AI Agents
│ ├── MCP Integration
│ └── Natural Functions
└── Tutorials
Guides
├── Enterprise Integration Patterns
└── Migration Guides
Deployment ← was "Deploy"
├── WSO2 Cloud ← was "Deploy to WSO2 Cloud"
├── Self-Hosted
├── CI/CD
├── Observe
├── Secure
└── Capacity Planning
Management ← was "Manage"
├── WSO2 Cloud
│ ├── Integrations
│ ├── Projects
│ ├── Configurations
│ ├── Environments
│ ├── Observability
│ ├── CI/CD
│ ├── Users and Access
│ ├── Platform Services
│ ├── RAG (Retrieval-Augmented Generation)
│ ├── Billing
│ ├── Audit
│ └── Private Data Plane
└── ICP
├── ...
├── User Stores
└── MI Profile
Reference
├── Language
├── Configuration
├── Project
├── ICP Configuration
├── APIs
├── Supported Protocols
├── Supported Data Formats
├── Network ← was "Miscellaneous"
├── Error Codes ← promoted from "Appendix"
├── Glossary ← promoted from "Appendix"
├── FAQ ← promoted from "Appendix"
└── Release Notes ← promoted from "Appendix"
Action items
Here are the main consistency issues with the current sidebar labels, in order of priority:
1. The current top-level section uses different grammatical forms:
Get Started-> verb phrase,Develop/Deploy/Manage-> bare verbsConnectors/AI Integrations/Reference-> nounsSuggestion: Items at the same nav level must share one form. Two options:
Get StartedGetting StartedStartDevelopDevelopmentConnectorsConnectAI IntegrationsIntegrate AIGuidesDeployDeploymentManageManagementReferencePreferred: Option A. Five of eight labels are already nouns and need no change. Option B breaks down on
GuidesandReference, which have no natural verb equivalents.2. Items directly under
Developsection uses different grammatical forms:-
Create Integrations/Understand the IDE-> verb phrases-
Transform/Test/Debug-> bare verbs-
Integration Artifacts/Tools-> nouns-
Troubleshooting-> gerundSuggestion: Normalize to one form. Two options:
Create IntegrationsCreating IntegrationsCreateUnderstand the IDEIDE OverviewExploreIntegration ArtifactsTransformTransformationsWSO2 Integrator CopilotTestTestingDebugDebuggingTroubleshootingTroubleshootToolsPreferred: Option A. Option B breaks down on
Integration ArtifactsandTools, which are catalog sections with no natural verb equivalent. Option A keeps those as-is and produces clean, unambiguous names across the board.3. The top-level section is named
Get Startedwhile the equivalent sub-section inside AI Integrations is namedGetting Started.Suggestion: Normalize to
Getting Started(gerund form is the industry standard for doc section names).4.
Deploy to WSO2 CloudandSelf-Hostedsections are listed under the same parent, but use opposite forms.Suggestion: Standardize both to noun phrases:
WSO2 CloudandSelf-Hosted.5. There are several single-item wrapper sections which add unnecessary depth and use vague labels:
OtherunderDevelop → Toolsis a single-item wrapper whose only content is the scan tool.Suggestion: Promote the scan tool directly to the Tools level and drop the wrapper.
MiscellaneousunderReferencecontains network proxy configuration docs.Suggestion: Rename it to
NetworkorEnvironment Setup.AppendixunderReferenceis a print convention that reads oddly in web navigation.Suggestion: Promote its contents (Error Codes, Glossary, FAQ, Release Notes) as flat items directly under Reference and remove the wrapper.
6.
Build Your OwnandConnector Catalogare listed under Connectors but use opposite forms.Suggestion: Rename
Build Your OwntoCustom Connectors.Proposed structure
Getting Started ← was "Get Started" ├── Concepts ├── Set Up └── Quick Starts Development ← was "Develop" ├── Creating Integrations ← was "Create Integrations" ├── IDE Overview ← was "Understand the IDE" ├── Integration Artifacts │ ├── Integration as API │ ├── Event-Driven Integration │ ├── File-Driven Integration │ └── Other Artifacts ├── Transformations ← was "Transform" ├── WSO2 Integrator Copilot ├── Testing ← was "Test" ├── Debugging ← was "Debug" ├── Troubleshooting └── Tools ├── Integration Tools ├── Migration Tools └── Scan Tool ← was under "Other" wrapper Connectors ├── Connector Catalog └── Custom Connectors ← was "Build Your Own" AI Integrations ├── Getting Started ├── Develop AI Applications │ ├── Direct LLM Calls │ ├── RAG │ ├── AI Agents │ ├── MCP Integration │ └── Natural Functions └── Tutorials Guides ├── Enterprise Integration Patterns └── Migration Guides Deployment ← was "Deploy" ├── WSO2 Cloud ← was "Deploy to WSO2 Cloud" ├── Self-Hosted ├── CI/CD ├── Observe ├── Secure └── Capacity Planning Management ← was "Manage" ├── WSO2 Cloud │ ├── Integrations │ ├── Projects │ ├── Configurations │ ├── Environments │ ├── Observability │ ├── CI/CD │ ├── Users and Access │ ├── Platform Services │ ├── RAG (Retrieval-Augmented Generation) │ ├── Billing │ ├── Audit │ └── Private Data Plane └── ICP ├── ... ├── User Stores └── MI Profile Reference ├── Language ├── Configuration ├── Project ├── ICP Configuration ├── APIs ├── Supported Protocols ├── Supported Data Formats ├── Network ← was "Miscellaneous" ├── Error Codes ← promoted from "Appendix" ├── Glossary ← promoted from "Appendix" ├── FAQ ← promoted from "Appendix" └── Release Notes ← promoted from "Appendix"Action items
en/sidebars.ts:)en/content-gen/00-rules.md)