Skip to content

docs: /TOOLS page missing sidebar — path mismatch #303

@polaz

Description

@polaz

Problem

The /TOOLS page (Full API Reference) has no sidebar navigation.

URL: https://gitlab-mcp.sw.foundation/TOOLS

Root Cause

VitePress sidebar uses path prefix matching. The sidebar is defined for /tools/ but the auto-generated file is at /TOOLS (root level, uppercase).

Current state:

  • File generated to: docs/TOOLS.md (root, uppercase)
  • Sidebar defined for: /tools/ (lowercase, with trailing slash)
  • Result: /TOOLS doesn't match any sidebar pattern

Config reference (docs/.vitepress/config.mts:173-191):

"/tools/": [
  {
    text: "Tool Reference",
    items: [
      { text: "Overview", link: "/tools/" },
      { text: "Full API Reference", link: "/TOOLS" },  // <- links to unmapped path
    ],
  },
  // ...
],

Generation (.github/workflows/docs.yml:74):

yarn list-tools --export --toc > docs/TOOLS.md

Proposed Solution

Move the generated file into /tools/ directory so it inherits the sidebar:

Option A: Rename to lowercase in tools/ (Recommended)

# docs.yml
yarn list-tools --export --toc > docs/tools/api-reference.md

Update config:

{ text: "Full API Reference", link: "/tools/api-reference" },

Option B: Add explicit sidebar for /TOOLS

sidebar: {
  "/TOOLS": [/* same as /tools/ */],
  "/tools/": [/* existing */],
}

This is less clean — duplicates sidebar config.

Steps to Reproduce

  1. Go to https://gitlab-mcp.sw.foundation/TOOLS
  2. Observe: no sidebar on the left
  3. Compare with https://gitlab-mcp.sw.foundation/tools/ — has sidebar

Expected Behavior

/TOOLS page should have the same sidebar as other /tools/* pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugCode defect, incorrect behaviordocumentationImprovements or additions to documentationreleased

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions