Skip to content

Standardize sidebar section names - #651

Open
Sachindu-Nethmin wants to merge 1 commit into
wso2:5.1.xfrom
Sachindu-Nethmin:fix/sidebar-label-consistency
Open

Standardize sidebar section names#651
Sachindu-Nethmin wants to merge 1 commit into
wso2:5.1.xfrom
Sachindu-Nethmin:fix/sidebar-label-consistency

Conversation

@Sachindu-Nethmin

@Sachindu-Nethmin Sachindu-Nethmin commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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). The Reference and Develop → Tools sections 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 Started vs Getting Started

Before After
Get Started Getting Started
Develop Development
Deploy Deployment
Manage Management

Connectors, AI Integrations, Guides and Reference were already nouns and are unchanged. The top level now matches the Getting Started sub-section inside AI Integrations.

2 — items under Develop

Create IntegrationsCreating Integrations, Understand the IDEIDE Overview, TransformTransformations, TestTesting, DebugDebugging. Integration Artifacts, WSO2 Integrator Copilot, Troubleshooting and Tools were already nouns.

4 — deployment targets

Deploy to WSO2 CloudWSO2 Cloud, alongside the existing Self-Hosted.

5 — wrapper categories

  • Develop → Tools → Other removed; scan-tool promoted to sit beside Integration Tools and Migration Tools.
  • Reference → Miscellaneous renamed to Network (its two pages are both network proxy configuration).
  • Reference → Appendix removed; Error Codes, Glossary, FAQ and Release Notes promoted to flat items under Reference.

6 — connector sections

Build Your OwnCustom Connectors, matching Connector Catalog.

Convention rule — two bullets added to en/content-gen/00-rules.md beside 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.x sidebar. Both columns in each image are the same page at the same URL, so the only difference is the sidebar.

Top-level sections

Top-level sidebar sections, before and after

Development section — renamed children, and Tools -> Other -> Scan Tool flattened to Tools -> Scan Tool

Development section of the sidebar, before and after

Reference sectionMiscellaneous renamed to Network, and the Appendix wrapper replaced by its four pages

Reference section of the sidebar, before and after

Both 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.ts contains no generated-index categories and no slug: overrides, and that no redirects plugin is configured, so no category owns a route of its own. The two removed wrappers had no link: 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.md is titled "Deploy to WSO2 Cloud" under the WSO2 Cloud category, and connectors/build-your-own/build-own.md is titled "Build Your Own Connector" under Custom 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 Other and Appendix wrapper 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

  • Unit tests
    N/A
  • Integration tests
    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.ts parses cleanly with tsc (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-sidebars plugin keys off document IDs and sidebar_label front matter rather than category labels, so neither renaming a category nor removing a wrapper affects URLs or that plugin.

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.
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 7549d3fc-c88b-4a1b-a547-8a51d806accf

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

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

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
@Sachindu-Nethmin Sachindu-Nethmin changed the title Standardize sidebar section names (#513) Standardize sidebar section names Sep 4, 2026
@AmilaSamith AmilaSamith added the Contributor Assigned to pull requests received from external contributors label Sep 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Contributor Assigned to pull requests received from external contributors

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants