Skip to content

Commit c9f7cba

Browse files
authored
docs(docs-site): 사이드바 재정렬 + getting-started 강화 + TOC 복원 (4개 로케일) (#698)
* docs(docs-site): 사이드바 재정렬 + getting-started 본문 강화 + TOC 복원 (4개 로케일) 사용자 학습 여정에 맞춰 좌측 사이드바 순서를 재정렬하고, 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> * chore(skills): brand-design/copywriting을 non-user-invocable로 변경 두 스킬은 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>
1 parent bd0e228 commit c9f7cba

24 files changed

Lines changed: 231 additions & 33 deletions

File tree

docs-site/content/en/_meta.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
"getting-started":
22
title: "Getting Started"
3+
weight: 10
34
"core-concepts":
45
title: "Core Concepts"
6+
weight: 20
57
"workflow-commands":
68
title: "Workflow Commands"
9+
weight: 30
710
"utility-commands":
811
title: "Utility Commands"
12+
weight: 40
913
"quality-commands":
1014
title: "Quality Commands"
15+
weight: 50
1116
design:
1217
title: "Design System"
18+
weight: 60
1319
db:
1420
title: "Database Schema Management"
15-
weight: 15
16-
advanced:
17-
title: "Advanced"
21+
weight: 70
1822
worktree:
1923
title: "Git Worktree"
24+
weight: 90
25+
advanced:
26+
title: "Advanced"
27+
weight: 100

docs-site/content/en/advanced/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Advanced
3-
weight: 80
3+
weight: 100
44
draft: false
55
---
66

docs-site/content/en/db/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Database Schema Management
33
description: Automatically track and manage schemas, migrations, and seed data
4-
weight: 15
4+
weight: 70
55
draft: false
66
---
77

docs-site/content/en/design/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Design System
33
description: Hybrid design workflow combining Claude Design and code-based paths
4-
weight: 10
4+
weight: 60
55
draft: false
66
---
77

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
11
---
22
title: Getting Started
3+
description: Step-by-step guide from installation to running your first MoAI-ADK project
34
weight: 10
45
draft: false
56
---
67

7-
Learn how to get started with MoAI-ADK.
8+
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.
9+
10+
{{< callout type="info" >}}
11+
Already installed? Jump straight to [Quick Start](./quickstart). Looking for CLI flags, see [CLI Reference](./cli). Hitting an issue, try the [FAQ](./faq).
12+
{{< /callout >}}
13+
14+
## Learning Flow
15+
16+
```mermaid
17+
flowchart TD
18+
A["Introduction<br>WHAT/WHY"] --> B["Installation<br>Prerequisites"]
19+
B --> C["Setup Wizard<br>moai init"]
20+
C --> D["Quick Start<br>First SPEC"]
21+
D --> E["Update<br>Keep Current"]
22+
E --> F["CLI / FAQ<br>Reference"]
23+
```
24+
25+
## Recommended Reading Order
26+
27+
| Step | Document | What you will learn |
28+
|------|----------|---------------------|
29+
| 1 | [Introduction](./introduction) | What MoAI-ADK is and the problems it solves |
30+
| 2 | [Installation](./installation) | Install on macOS/Linux and verify prerequisites |
31+
| 3 | [Setup Wizard](./init-wizard) | Configure your project with `moai init` |
32+
| 4 | [Quick Start](./quickstart) | Create your first SPEC and run `/moai plan → run → sync` |
33+
| 5 | [Update](./update) | Keep your templates and binary up to date |
34+
| 6 | [CLI Reference](./cli) | Complete index of `moai` subcommands |
35+
| 7 | [FAQ](./faq) | Common installation and runtime issues |
36+
37+
{{< callout type="info" >}}
38+
**Next step**: After finishing installation, explore [Core Concepts](/en/core-concepts/) to learn about SPEC-based development, DDD, and the TRUST 5 quality framework.
39+
{{< /callout >}}

docs-site/content/ja/_meta.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
"getting-started":
22
title: "はじめに"
3+
weight: 10
34
"core-concepts":
45
title: "コア概念"
6+
weight: 20
57
"workflow-commands":
68
title: "ワークフローコマンド"
9+
weight: 30
710
"utility-commands":
811
title: "ユーティリティコマンド"
12+
weight: 40
913
"quality-commands":
1014
title: "品質コマンド"
15+
weight: 50
1116
design:
1217
title: "デザインシステム"
18+
weight: 60
1319
db:
1420
title: "データベーススキーマ管理"
15-
weight: 15
16-
advanced:
17-
title: "詳細"
21+
weight: 70
1822
worktree:
1923
title: "Git Worktree"
24+
weight: 90
25+
advanced:
26+
title: "詳細"
27+
weight: 100

docs-site/content/ja/advanced/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 上級トピック
3-
weight: 80
3+
weight: 100
44
draft: false
55
---
66

docs-site/content/ja/db/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: データベーススキーマ管理
33
description: スキーマ、マイグレーション、シードデータを自動的に追跡および管理
4-
weight: 15
4+
weight: 70
55
draft: false
66
---
77

docs-site/content/ja/design/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: デザインシステム
33
description: Claude Designとコードベースパスを組み合わせたハイブリッド設計ワークフロー
4-
weight: 10
4+
weight: 60
55
draft: false
66
---
77

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
11
---
22
title: はじめに
3+
description: インストールから最初の MoAI-ADK プロジェクト実行までのステップバイステップガイド
34
weight: 10
45
draft: false
56
---
67

7-
MoAI-ADK の使用方法を学びます。
8+
MoAI-ADK へようこそ。**紹介 → インストール → クイックスタート** の順に読み進めれば、30 分以内に最初の MoAI-ADK プロジェクトを実行できます。
9+
10+
{{< callout type="info" >}}
11+
すでにインストール済みの場合は [クイックスタート](./quickstart) へ。CLI フラグを探している場合は [CLI リファレンス](./cli) を、問題が発生した場合は [FAQ](./faq) を参照してください。
12+
{{< /callout >}}
13+
14+
## 学習の流れ
15+
16+
```mermaid
17+
flowchart TD
18+
A["紹介<br>WHAT/WHY"] --> B["インストール<br>前提条件"]
19+
B --> C["セットアップ<br>moai init"]
20+
C --> D["クイックスタート<br>初めての SPEC"]
21+
D --> E["アップデート<br>最新維持"]
22+
E --> F["CLI / FAQ<br>リファレンス"]
23+
```
24+
25+
## 推奨される読む順序
26+
27+
| 順序 | ドキュメント | 学べること |
28+
|------|--------------|-----------|
29+
| 1 | [紹介](./introduction) | MoAI-ADK とは何か、どんな問題を解決するのか |
30+
| 2 | [インストール](./installation) | macOS/Linux へのインストールと前提条件確認 |
31+
| 3 | [セットアップウィザード](./init-wizard) | `moai init` でプロジェクトを構成 |
32+
| 4 | [クイックスタート](./quickstart) | 最初の SPEC を作成し `/moai plan → run → sync` を実行 |
33+
| 5 | [アップデート](./update) | テンプレートとバイナリを最新に保つ |
34+
| 6 | [CLI リファレンス](./cli) | `moai` サブコマンドの完全索引 |
35+
| 7 | [よくある質問](./faq) | インストール・実行時に遭遇する一般的な問題 |
36+
37+
{{< callout type="info" >}}
38+
**次のステップ**: インストールが完了したら、[コア概念](/ja/core-concepts/) で SPEC ベース開発、DDD、TRUST 5 品質フレームワークを学びましょう。
39+
{{< /callout >}}

0 commit comments

Comments
 (0)