Skip to content

docs: ungroup components in docs and list alphabetically#1712

Merged
junghyeonsu merged 2 commits into
devfrom
baghdad-v2
Jun 23, 2026
Merged

docs: ungroup components in docs and list alphabetically#1712
junghyeonsu merged 2 commits into
devfrom
baghdad-v2

Conversation

@junghyeonsu

@junghyeonsu junghyeonsu commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Ungroup the component docs under docs/content/docs/components so the sidebar lists every component alphabetically, matching the existing react/components structure.

Changes

  • Move 43 component .mdx files out of the six category folders ((buttons), (controls), (display), (feedback), (layout), (navigation)) into the components/ root. URLs are unchanged — these are fumadocs route groups.
  • Delete the six group meta.json files; (deprecated) stays as its own group at the end.
  • components/meta.json["index", "...", "(deprecated)"] so the "..." rest entry auto-lists the remaining components A-Z.
  • component-grid.tsx: drop the category sections, render a single A-Z card grid.
  • component-grid-rule.ts (LLM markdown rule): same flattening; test + fixture updated.

Verification

  • bun test app/_llms/rules/component-grid-rule.test.ts → 2 pass / 0 fail
  • tsc --noEmit → no component-grid type errors
  • biome format clean; no internal links reference the old group paths

🤖 Generated with Claude Code

Summary by CodeRabbit

릴리스 노트

  • Documentation
    • 컴포넌트 문서 목록 레이아웃을 카테고리별 섹션 형식에서 알파벳순 단일 리스트로 변경했습니다.
    • 문서 구조를 단순화하여 컴포넌트 검색 및 탐색이 더욱 용이해졌습니다.

Flatten the six category folders ((buttons), (controls), (display),
(feedback), (layout), (navigation)) into the components root so the
sidebar lists components A-Z via the "..." rest entry. Deprecated keeps
its own group at the end. ComponentGrid and the LLM markdown rule no
longer derive categories from folder paths.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 75c5051

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 04eb90d6-a325-418c-9b5e-2553b0357df0

📥 Commits

Reviewing files that changed from the base of the PR and between 5da5ea3 and 75c5051.

📒 Files selected for processing (54)
  • docs/app/_llms/__fixtures__/component-grid/basic.output.md
  • docs/app/_llms/rules/component-grid-rule.test.ts
  • docs/app/_llms/rules/component-grid-rule.ts
  • docs/components/component-grid.tsx
  • docs/content/docs/components/(buttons)/meta.json
  • docs/content/docs/components/(controls)/meta.json
  • docs/content/docs/components/(display)/meta.json
  • docs/content/docs/components/(feedback)/meta.json
  • docs/content/docs/components/(layout)/meta.json
  • docs/content/docs/components/(navigation)/meta.json
  • docs/content/docs/components/accordion.mdx
  • docs/content/docs/components/action-button.mdx
  • docs/content/docs/components/alert-dialog.mdx
  • docs/content/docs/components/attachment-input.mdx
  • docs/content/docs/components/avatar.mdx
  • docs/content/docs/components/badge.mdx
  • docs/content/docs/components/bottom-navigation.mdx
  • docs/content/docs/components/bottom-sheet.mdx
  • docs/content/docs/components/callout.mdx
  • docs/content/docs/components/checkbox.mdx
  • docs/content/docs/components/chip.mdx
  • docs/content/docs/components/content-placeholder.mdx
  • docs/content/docs/components/contextual-floating-button.mdx
  • docs/content/docs/components/divider.mdx
  • docs/content/docs/components/field.mdx
  • docs/content/docs/components/floating-action-button.mdx
  • docs/content/docs/components/help-bubble.mdx
  • docs/content/docs/components/identity-placeholder.mdx
  • docs/content/docs/components/image-frame.mdx
  • docs/content/docs/components/input-button.mdx
  • docs/content/docs/components/list.mdx
  • docs/content/docs/components/manner-temp.mdx
  • docs/content/docs/components/menu-sheet.mdx
  • docs/content/docs/components/menu.mdx
  • docs/content/docs/components/meta.json
  • docs/content/docs/components/notification-badge.mdx
  • docs/content/docs/components/page-banner.mdx
  • docs/content/docs/components/progress-circle.mdx
  • docs/content/docs/components/radio.mdx
  • docs/content/docs/components/reaction-button.mdx
  • docs/content/docs/components/result-section.mdx
  • docs/content/docs/components/scroll-fog.mdx
  • docs/content/docs/components/segmented-control.mdx
  • docs/content/docs/components/select-box.mdx
  • docs/content/docs/components/side-navigation.mdx
  • docs/content/docs/components/side-panel.mdx
  • docs/content/docs/components/skeleton.mdx
  • docs/content/docs/components/slider.mdx
  • docs/content/docs/components/snackbar.mdx
  • docs/content/docs/components/switch.mdx
  • docs/content/docs/components/tabs.mdx
  • docs/content/docs/components/tag-group.mdx
  • docs/content/docs/components/text-input.mdx
  • docs/content/docs/components/top-navigation.mdx
💤 Files with no reviewable changes (6)
  • docs/content/docs/components/(display)/meta.json
  • docs/content/docs/components/(feedback)/meta.json
  • docs/content/docs/components/(layout)/meta.json
  • docs/content/docs/components/(navigation)/meta.json
  • docs/content/docs/components/(buttons)/meta.json
  • docs/content/docs/components/(controls)/meta.json

📝 Walkthrough

Walkthrough

컴포넌트 그리드에서 카테고리 기반 그룹핑을 제거하고, ComponentEntry 타입에서 category 필드를 삭제했습니다. loadEntries()는 카테고리 디렉터리 스캔 대신 루트 .mdx 파일 직접 스캔으로 변경되었고, buildMarkdown()ComponentGrid 렌더링은 단일 알파벳 정렬 리스트로 평탄화되었습니다.

Changes

컴포넌트 그리드 카테고리 제거 및 평탄화

Layer / File(s) Summary
ComponentEntry 타입 및 loadEntries/buildMarkdown 로직 변경
docs/app/_llms/rules/component-grid-rule.ts
ComponentEntry에서 category 필드 제거. loadEntries()가 카테고리 디렉터리 스캔 대신 componentsDir 루트의 .mdx 파일을 직접 스캔하도록 변경. buildMarkdown()은 카테고리별 헤딩+그룹 대신 title 기준 정렬 단일 불릿 리스트를 생성.
ComponentGrid UI 평탄화 및 meta.json 정리
docs/components/component-grid.tsx, docs/content/docs/components/meta.json, docs/content/docs/components/(buttons)/meta.json, docs/content/docs/components/(controls)/meta.json, docs/content/docs/components/(display)/meta.json, docs/content/docs/components/(feedback)/meta.json, docs/content/docs/components/(layout)/meta.json, docs/content/docs/components/(navigation)/meta.json
ComponentGrid가 카테고리 맵 그룹핑 및 section/h2 섹션 렌더링을 제거하고 단일 <ul> 그리드로 변경. 카테고리 디렉터리 meta.json에서 title/defaultOpen 설정 제거, docs/components/meta.jsonpages 배열 축소.
테스트 및 픽스처 업데이트
docs/app/_llms/rules/component-grid-rule.test.ts, docs/app/_llms/__fixtures__/component-grid/basic.output.md
sampleEntries에서 category 속성 제거, 첫 번째 테스트 설명이 "카테고리별 렌더링"에서 "알파벳 순 정렬 렌더링"으로 변경. basic.output.md 픽스처도 섹션 헤더 없는 단일 리스트로 업데이트.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 카테고리 토끼굴, 이젠 필요 없어요~
버튼도 컨트롤도 한 줄에 쏙!
category 필드야 안녕 잘 가렴,
알파벳 순서로 깔끔하게 정렬~
단일 리스트, 토끼처럼 깡충깡충! 🥕

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목이 변경 내용의 주요 목표를 명확하게 요약하고 있습니다. '컴포넌트 그룹화 해제 및 알파벳 순 정렬'이라는 핵심 변경사항을 간결하고 구체적으로 표현하고 있습니다.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch baghdad-v2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Stackflow SPA)

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Storybook)

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Alpha Preview (Docs)

Drop "index" from the components meta.json pages array. With it listed,
the folder index page (title "Components") was rendered as a standalone
sidebar item under the "Components" group. Omitting it lets fumadocs use
index.mdx only as the folder's representative page, so the "..." rest
entry lists the components A-Z without the duplicate.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@junghyeonsu junghyeonsu merged commit af51b27 into dev Jun 23, 2026
9 checks passed
@junghyeonsu junghyeonsu deleted the baghdad-v2 branch June 23, 2026 09:14
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