docs(docs-site): 사이드바 재정렬 + getting-started 강화 + TOC 복원 (4개 로케일)#698
Open
docs(docs-site): 사이드바 재정렬 + getting-started 강화 + TOC 복원 (4개 로케일)#698
Conversation
사용자 학습 여정에 맞춰 좌측 사이드바 순서를 재정렬하고, 1024~1280px 뷰포트에서 사라지던 좌/우 사이드바를 복원했다. ## 변경 요약 - 최상위 사이드바 weight 재배치 (ko/en/ja/zh 4개 로케일) 시작하기(10) → 핵심 개념(20) → 워크플로우(30) → 유틸(40) → 품질(50) → 디자인(60) → DB(70) → 멀티LLM(80) → Worktree(90) → 심화(100) → 참여하기(110) - _meta.yaml에 weight 명시 + 각 _index.md weight 동기화 - db/_index.md weight 15 → 70 (일관성) - design/_index.md weight 10 → 60 (4개 로케일) - advanced/_index.md weight 80 → 100 (4개 로케일) ## getting-started/_index.md 본문 강화 (4개 로케일) 기존 7줄 단문에서 학습 여정 다이어그램 + 권장 읽기 순서 표로 확장. Mermaid TD flowchart + cards-style 테이블 + 다음 단계 callout. ## 레이아웃 복원 - hugo.yaml cascade.target.path=/** + type=docs 추가 Hextra 기본 single.html은 disableSidebar=true를 주입하므로 모든 페이지가 docs/single.html을 사용하도록 type=docs 전파. - layouts/partials/custom/head-end.html에 media query 추가 1024~1279px 구간에서 aside.hextra-sidebar-container 및 nav.hextra-toc를 display:block으로 복원. ## 검증 - 4개 로케일 홈/섹션/개별 페이지 67개 HTTP 200 OK (ko 기준) - Chrome DevTools 1101px 뷰포트에서 좌/본문/우 3-column 렌더 확인 - 콘솔 에러 0건, Hugo warn 3건(deprecated API, 콘텐츠 영향 없음) 🗿 MoAI <email@mo.ai.kr>
두 스킬은 designer/copywriter 에이전트가 백그라운드로 사용하도록 설계된 도메인 스킬이다. 사용자가 슬래시 메뉴에서 직접 호출하지 않도록 user-invocable을 false로 바꿔 / 메뉴에서 숨긴다. Claude는 여전히 내부적으로 로드하고 활용한다. ## 변경 파일 - .claude/skills/moai-domain-brand-design/SKILL.md - .claude/skills/moai-domain-copywriting/SKILL.md - internal/template/templates/.claude/skills/moai-domain-brand-design/SKILL.md - internal/template/templates/.claude/skills/moai-domain-copywriting/SKILL.md ## 영향 - 슬래시 명령 메뉴에 `moai-domain-brand-design`, `moai-domain-copywriting` 항목이 노출되지 않음 - 에이전트가 skill을 호출하는 기존 동작은 변경 없음 - 신규 프로젝트 `moai init` 시 템플릿이 동일 설정 적용 🗿 MoAI <email@mo.ai.kr>
WalkthroughThe PR updates documentation navigation ordering across multiple language versions (English, Japanese, Korean, Chinese), reorganizes section weights with database content moving from priority 15→70 and advanced section to 100, enriches getting-started landing pages with onboarding content and learning flow diagrams, disables direct user invocation of two domain-specific skills, and modifies Hugo site configuration to enforce docs layout with sidebar behavior customizations. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Collaborator
Author
|
@claude CI 빌드가 실패했습니다. 오류를 분석하고 수정해주세요. 실패한 워크플로우: CI 실패 로그를 확인하고 근본 원인을 파악한 뒤 수정해주세요. Latte AI CI Monitor • latte@mo.ai.kr |
Collaborator
Author
|
@claude CI 빌드가 실패했습니다. 오류를 분석하고 수정해주세요. 실패한 워크플로우: Claude Code Review 실패 로그를 확인하고 근본 원인을 파악한 뒤 수정해주세요. Latte AI CI Monitor • latte@mo.ai.kr |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-site/content/en/getting-started/_index.md`:
- Line 11: The sentence contains comma splices; split them into short question
prompts and follow-up sentences—edit the phrase "Already installed? Jump
straight to [Quick Start](./quickstart). Looking for CLI flags? See [CLI
Reference](./cli). Hitting an issue? Try the [FAQ](./faq)." so each prompt ends
with a question mark and the action becomes its own sentence, preserving the
existing link targets and wording.
In `@docs-site/layouts/partials/custom/head-end.html`:
- Line 70: The media query currently reads "@media (min-width: 1024px) and
(max-width: 1279px) {" which can match print media; scope it explicitly to
screen by changing the media query to use "screen and (min-width: 1024px) and
(max-width: 1279px)" so the override only applies to screen viewports and cannot
affect print/PDF output.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: eda5339d-86c4-4b0b-b8bb-bea121d40114
📒 Files selected for processing (28)
.claude/skills/moai-domain-brand-design/SKILL.md.claude/skills/moai-domain-copywriting/SKILL.mddocs-site/content/en/_meta.yamldocs-site/content/en/advanced/_index.mddocs-site/content/en/db/_index.mddocs-site/content/en/design/_index.mddocs-site/content/en/getting-started/_index.mddocs-site/content/ja/_meta.yamldocs-site/content/ja/advanced/_index.mddocs-site/content/ja/db/_index.mddocs-site/content/ja/design/_index.mddocs-site/content/ja/getting-started/_index.mddocs-site/content/ko/_meta.yamldocs-site/content/ko/advanced/_index.mddocs-site/content/ko/contributing/_index.mddocs-site/content/ko/db/_index.mddocs-site/content/ko/design/_index.mddocs-site/content/ko/getting-started/_index.mddocs-site/content/ko/multi-llm/_index.mddocs-site/content/zh/_meta.yamldocs-site/content/zh/advanced/_index.mddocs-site/content/zh/db/_index.mddocs-site/content/zh/design/_index.mddocs-site/content/zh/getting-started/_index.mddocs-site/hugo.yamldocs-site/layouts/partials/custom/head-end.htmlinternal/template/templates/.claude/skills/moai-domain-brand-design/SKILL.mdinternal/template/templates/.claude/skills/moai-domain-copywriting/SKILL.md
| Welcome to MoAI-ADK. Follow the **Introduction → Installation → Quick Start** path and you will have your first MoAI-ADK project running in under 30 minutes. | ||
|
|
||
| {{< callout type="info" >}} | ||
| Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags, see [CLI Reference](./cli). Hitting an issue, try the [FAQ](./faq). |
There was a problem hiding this comment.
Tighten the English callout punctuation.
The current sentence reads like comma splices. Use question-style prompts for clearer user-facing docs.
Proposed copy edit
-Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags, see [CLI Reference](./cli). Hitting an issue, try the [FAQ](./faq).
+Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags? See [CLI Reference](./cli). Hitting an issue? Try the [FAQ](./faq).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags, see [CLI Reference](./cli). Hitting an issue, try the [FAQ](./faq). | |
| Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags? See [CLI Reference](./cli). Hitting an issue? Try the [FAQ](./faq). |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-site/content/en/getting-started/_index.md` at line 11, The sentence
contains comma splices; split them into short question prompts and follow-up
sentences—edit the phrase "Already installed? Jump straight to [Quick
Start](./quickstart). Looking for CLI flags? See [CLI Reference](./cli). Hitting
an issue? Try the [FAQ](./faq)." so each prompt ends with a question mark and
the action becomes its own sentence, preserving the existing link targets and
wording.
| Tailwind JIT 이스케이프 클래스는 런타임에 주입 불가하므로 media query 직접 작성. | ||
| */}} | ||
| <style> | ||
| @media (min-width: 1024px) and (max-width: 1279px) { |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's examine the file context
head -n 90 docs-site/layouts/partials/custom/head-end.html | tail -n 30Repository: modu-ai/moai-adk
Length of output: 943
🏁 Script executed:
# Check for other media queries in the same file
grep -n "@media" docs-site/layouts/partials/custom/head-end.htmlRepository: modu-ai/moai-adk
Length of output: 117
🏁 Script executed:
# Also check if there are other media queries elsewhere in the codebase that might use 'screen'
rg "@media\s+screen" docs-site/ -A 1 | head -20Repository: modu-ai/moai-adk
Length of output: 42
🏁 Script executed:
# Check for media queries without 'screen' in the same directory
rg "@media\s+\(" docs-site/layouts/partials/custom/ -A 1Repository: modu-ai/moai-adk
Length of output: 251
🏁 Script executed:
# Search for media queries across the entire docs-site to see the pattern
rg "@media" docs-site/ -A 1 | head -40Repository: modu-ai/moai-adk
Length of output: 251
🏁 Script executed:
# Check if this is Hugo/template code and what the print behavior should be
grep -r "@media" . --include="*.html" --include="*.css" -B 2 -A 2 | head -50Repository: modu-ai/moai-adk
Length of output: 455
🏁 Script executed:
# Let me check if there's any documentation or comments about print media handling
grep -n "print" docs-site/layouts/partials/custom/head-end.htmlRepository: modu-ai/moai-adk
Length of output: 110
🏁 Script executed:
# Check the actual CSS default media type behavior and width calculations in print
cat <<'EOF' > /tmp/check_media.py
# According to CSS Media Queries spec, when no media type is specified,
# it defaults to 'all', which includes print, screen, speech, etc.
# The concern is:
# 1. Without 'screen', `@media` (min-width: 1024px) applies to all media types
# 2. With display: flex !important and display: block !important,
# these would override any print-hiding styles if the condition matches
# In print/PDF:
# - Page width is typically 8-9 inches (768-864px @ 96dpi, or ~595-728px CSS px)
# - This would NOT normally match the 1024-1279px condition
# - But technically, it could if page box width is set differently
# Best practice: Be explicit about media type when you mean 'screen'
print("Analysis: The review comment is technically correct.")
print("The `@media` query should include 'screen' to:")
print("1. Be explicit about intent (screen-only responsive design)")
print("2. Prevent unintended application to print media")
print("3. Follow CSS best practices")
EOF
python /tmp/check_media.pyRepository: modu-ai/moai-adk
Length of output: 295
Scope the breakpoint override to screen media.
This layout override is intended for browser viewports; without screen, it can also apply to print/PDF media when the page box width matches, and the !important display rules may override print hiding.
Proposed fix
- `@media` (min-width: 1024px) and (max-width: 1279px) {
+ `@media` screen and (min-width: 1024px) and (max-width: 1279px) {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| @media (min-width: 1024px) and (max-width: 1279px) { | |
| `@media` screen and (min-width: 1024px) and (max-width: 1279px) { |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-site/layouts/partials/custom/head-end.html` at line 70, The media query
currently reads "@media (min-width: 1024px) and (max-width: 1279px) {" which can
match print media; scope it explicitly to screen by changing the media query to
use "screen and (min-width: 1024px) and (max-width: 1279px)" so the override
only applies to screen viewports and cannot affect print/PDF output.
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
1 participant
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.
Summary
hugo.yamlcascade(type=docs) +head-end.htmlmedia query로 복원moai-domain-brand-design/moai-domain-copywriting스킬을user-invocable: false로 변경하여 슬래시 메뉴 노출 제외 (에이전트 백그라운드 전용)재정렬 결과 (ko 기준)
이전 순서:
디자인 → 시작하기 → DB → 핵심 → ...(weight 미지정으로 인한 filesystem 순서 노출)Root Cause
_index.md가 모두weight:10hx:xl:blocksingle.html이disableSidebar:truecascade.target.path=/** + type=docsLocale Parity
CLAUDE.local.md §17.3 "ko/en/ja/zh 동시 업데이트" 준수. 4개 로케일 모두 즉시 반영.
Verification
.Site.*API, 콘텐츠 영향 없음)go vet ./...passcommands_audit_test, template audit 등 코드 테스트 미영향Test plan
학습 흐름다이어그램이 light/dark 모두 정상 렌더 확인moai-domain-brand-design,moai-domain-copywriting미노출 확인Commits
docs(docs-site): 사이드바 재정렬 + getting-started 본문 강화 + TOC 복원 (4개 로케일) — 24 fileschore(skills): brand-design/copywriting을 non-user-invocable로 변경 — 4 files🗿 MoAI email@mo.ai.kr
Summary by CodeRabbit
Documentation
Chores