Skip to content

fix(nav): show the Examples folder in the Developer sidebar - #146

Closed
majinghe wants to merge 1 commit into
rustfs:mainfrom
majinghe:fix/developer-nav-examples
Closed

majinghe wants to merge 1 commit into
rustfs:mainfrom
majinghe:fix/developer-nav-examples

Conversation

@majinghe

Copy link
Copy Markdown
Collaborator

Problem

The Developer section's meta.json listed only sdk, integration, and license — the developer/examples folder was never referenced, so it never appeared in the sidebar. All example pages (AWS CLI, s3cmd, rclone, boto3, capo, AWS SDK for JavaScript/Go, Terraform) were reachable only through direct links on other pages.

npm run docs:check did not flag this because its orphan rule counts any folder that owns a meta.json as referenced.

Fix

Add examples to the pages array in developer/meta.json, right after sdk, in all five locales (en, zh, de, fr, ja). Folder labels in the sidebar come from each locale's developer/examples/meta.json title (Examples / 示例 / Beispiele / Exemples / 使用例), which is already localized — no label changes needed.

Verification

  • npm run docs:check — PASS
  • npm run build — PASS (2515 files); the rendered /en/developer page now contains the Examples navigation entry with links to developer/examples/*

The developer/{meta.json} pages array listed only sdk, integration,
and license, so the developer/examples folder (aws-cli, s3cmd,
rclone, boto3, capo, aws-sdk-js, aws-sdk-go, terraform) never
appeared in the sidebar and was reachable only through direct page
links. docs:check did not flag it because its orphan rule counts a
folder with its own meta.json as referenced.

Add 'examples' after 'sdk' in all five locales (en, zh, de, fr, ja);
folder labels come from each locale's examples/meta.json title.
@vercel

vercel Bot commented Sep 20, 2026

Copy link
Copy Markdown

@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel.

A member of the Team first needs to authorize it.

@majinghe

Copy link
Copy Markdown
Collaborator Author

Superseded by #147: instead of adding the Examples folder to the sidebar, the capo guide moves under Developer → Integration → Others, keeping Examples out of the navigation.

@majinghe majinghe closed this Sep 20, 2026
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.

1 participant