Standardize sidebar section names - #651
Open
Sachindu-Nethmin wants to merge 1 commit into
Open
Conversation
Normalize sidebar labels to noun phrases so items at the same level share one grammatical form, following Option A in the issue: - Get Started -> Getting Started, Develop -> Development, Deploy -> Deployment, Manage -> Management - Create Integrations -> Creating Integrations, Understand the IDE -> IDE Overview, Transform -> Transformations, Test -> Testing, Debug -> Debugging - Deploy to WSO2 Cloud -> WSO2 Cloud, Build Your Own -> Custom Connectors - Miscellaneous -> Network Remove the single-item 'Other' wrapper under Tools and the 'Appendix' wrapper under Reference, promoting their contents to the parent level. Record the convention in the content generation rules so new sections follow it.
Sachindu-Nethmin
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
September 4, 2026 04:39
Contributor
|
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: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
Sachindu-Nethmin
added a commit
to Sachindu-Nethmin/docs-integrator
that referenced
this pull request
Sep 4, 2026
Sachindu-Nethmin
added a commit
to Sachindu-Nethmin/docs-integrator
that referenced
this pull request
Sep 4, 2026
Sachindu-Nethmin
added a commit
to Sachindu-Nethmin/docs-integrator
that referenced
this pull request
Sep 4, 2026
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.
Purpose
Resolves #513
Sidebar labels at the same nesting level mix grammatical forms — bare verbs (
Develop,Deploy,Manage), verb phrases (Get Started,Understand the IDE), and nouns (Connectors,Reference). TheReferenceandDevelop → Toolssections also carry vague wrapper categories (Appendix,Other) that add a level of depth for a handful of pages.Goals
Give every group of sibling sidebar items one consistent grammatical form, remove the vague wrappers, and record the convention so new sections follow it.
Approach
Implements Option A (all nouns) as preferred in the issue. All six sub-items are covered:
1 & 3 — top-level form, and
Get StartedvsGetting StartedGet StartedGetting StartedDevelopDevelopmentDeployDeploymentManageManagementConnectors,AI Integrations,GuidesandReferencewere already nouns and are unchanged. The top level now matches theGetting Startedsub-section inside AI Integrations.2 — items under Develop
Create Integrations→Creating Integrations,Understand the IDE→IDE Overview,Transform→Transformations,Test→Testing,Debug→Debugging.Integration Artifacts,WSO2 Integrator Copilot,TroubleshootingandToolswere already nouns.4 — deployment targets
Deploy to WSO2 Cloud→WSO2 Cloud, alongside the existingSelf-Hosted.5 — wrapper categories
Develop → Tools → Otherremoved;scan-toolpromoted to sit besideIntegration ToolsandMigration Tools.Reference → Miscellaneousrenamed toNetwork(its two pages are both network proxy configuration).Reference → Appendixremoved; Error Codes, Glossary, FAQ and Release Notes promoted to flat items underReference.6 — connector sections
Build Your Own→Custom Connectors, matchingConnector Catalog.Convention rule — two bullets added to
en/content-gen/00-rules.mdbeside the existing sidebar title-case rule: same-level labels share one grammatical form (noun phrases), and no single-item wrappers or vague grouping labels.Before and after
Captured from a local run of this branch, compared against the current
5.1.xsidebar. Both columns in each image are the same page at the same URL, so the only difference is the sidebar.Top-level sections
Development section — renamed children, and
Tools -> Other -> Scan Toolflattened toTools -> Scan ToolReference section —
Miscellaneousrenamed toNetwork, and theAppendixwrapper replaced by its four pagesBoth the before and after captures of the Development section were taken at the identical URL
/develop/tools/other/scan-tool, which confirms that removing the wrapper category changes the navigation without changing the route.On the redirects action item
No redirects are needed. Docusaurus derives routes from document IDs, not from sidebar labels or category nesting. I verified that
en/sidebars.tscontains nogenerated-indexcategories and noslug:overrides, and that no redirects plugin is configured, so no category owns a route of its own. The two removed wrappers had nolink:property — their children are plain doc IDs that keep their existing paths. Confirmed the five promoted IDs still resolve to files on disk, and that no duplicate IDs were introduced.Deliberately out of scope
Some page titles now read differently from the sidebar label that links to them — for example
deploy/cloud/overview.mdis titled "Deploy to WSO2 Cloud" under theWSO2 Cloudcategory, andconnectors/build-your-own/build-own.mdis titled "Build Your Own Connector" underCustom Connectors. The issue covers sidebar labels only, so I left page titles and body prose alone. Happy to follow up in a separate PR if you want them aligned.User stories
N/A
Release note
Standardize documentation sidebar section names to a consistent noun-phrase form and flatten the
OtherandAppendixwrapper sections.Documentation
N/A. This changes the documentation site's own navigation labels.
Training
N/A
Certification
N/A
Marketing
N/A. This changes user-visible navigation text, so it may warrant a review by documentation@wso2.com.
Automation tests
N/A
N/A. Covered by the existing PR build check.
Security checks
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
Verified
en/sidebars.tsparses cleanly withtsc(no syntax or type errors), bracket/brace balance is unchanged, the five promoted document IDs resolve to existing files, and no duplicate IDs were introduced. A full site build was not run locally; the PR build check covers it.Learning
Checked how Docusaurus resolves routes before assuming the rename needed redirects — routes come from document IDs, and the
expose-sidebarsplugin keys off document IDs andsidebar_labelfront matter rather than category labels, so neither renaming a category nor removing a wrapper affects URLs or that plugin.