Skip to content

Commit d4000e7

Browse files
committed
docs(mkdocs): add 6 missing files to navigation
- Add Two Pointers pattern documentation - Add Agent Evolved mind maps (en/zh-TW) - Add Ontology Design reference - Add Local Docs Build Options guide - Add MkDocs Content Guide
1 parent 4d22cf3 commit d4000e7

File tree

3 files changed

+68
-82
lines changed

3 files changed

+68
-82
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Most people practice algorithms in isolation. We built an **interconnected knowl
9393

9494
| Mind Map | Description | Link |
9595
|:---------|:------------|:----:|
96-
| 🤖 **AI Ontology Analysis (Evolved)** | Advanced AI-powered pattern synthesis with routing guides | [🔗 EN](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) · [🔗 中文](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
96+
| 🤖 **AI Ontology Analysis (Evolved)** | Generated via a multi-agent pipeline | [🔗 EN](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) · [🔗 中文](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
9797
| 🤖 **AI Ontology Analysis** | AI-powered deep pattern synthesis | [🔗 EN](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_en.html) · [🔗 中文](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_zh-TW.html) |
9898
| 📐 **Pattern Hierarchy** | API kernels → patterns → solutions | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/pattern_hierarchy.html) |
9999
| 👨‍👩‍👧‍👦 **Family Derivation** | Base templates → derived variants | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/family_derivation.html) |
@@ -276,8 +276,8 @@ Our **AI Ontology Analyzer** processes the entire knowledge graph — API Kernel
276276

277277
| Language | Description | Links |
278278
|:---------|:------------|:------|
279-
| **English (Evolved)** | Advanced AI synthesis with routing guides & pattern cheat sheets | [Static](docs/mindmaps/neetcode_ontology_agent_evolved_en.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) |
280-
| **繁體中文 (Evolved)** | 進階 AI 智能分析,含導航指南與模式速查表 | [Static](docs/mindmaps/neetcode_ontology_agent_evolved_zh-TW.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
279+
| **English (Evolved)** | Generated via a multi-agent pipeline | [Static](docs/mindmaps/neetcode_ontology_agent_evolved_en.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) |
280+
| **繁體中文 (Evolved)** | 由多代理(multi-agent)流程產生 | [Static](docs/mindmaps/neetcode_ontology_agent_evolved_zh-TW.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
281281
| **English** | AI-synthesized pattern relationships | [Static](docs/mindmaps/neetcode_ontology_ai_en.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_en.html) |
282282
| **繁體中文** | AI 智能分析模式關聯 | [Static](docs/mindmaps/neetcode_ontology_ai_zh-TW.md) · [Interactive ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_zh-TW.html) |
283283

README_zh-TW.md

Lines changed: 59 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,13 @@ AEO/GEO: 可擴展的 Python 框架,結合知識圖譜驅動學習、AI 心智
9292

9393
| 心智圖 | 說明 | 連結 |
9494
|:-------|:-----|:----:|
95+
| 🤖 **AI 本體論分析 (Evolved)** | 由多代理(multi-agent)流程產生 | [🔗 EN](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) · [🔗 中文](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
9596
| 🤖 **AI 本體論分析** | AI 深度模式合成 | [🔗 EN](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_en.html) · [🔗 中文](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_zh-TW.html) |
9697
| 📐 **模式階層** | API 核心 → 模式 → 解法 | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/pattern_hierarchy.html) |
9798
| 👨‍👩‍👧‍👦 **家族衍生** | 基礎模板 → 衍生變體 | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/family_derivation.html) |
9899
|**演算法使用** | 知道哪個演算法適用於哪裡 | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/algorithm_usage.html) |
99100
| 🏢 **公司覆蓋** | 針對特定公司精準準備 | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/company_coverage.html) |
100-
| 🗺️ **學習路線圖** | 遵循經過驗證的路徑 (NeetCode 150, Blind 75 等) | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/roadmap_paths.html) |
101+
| 🗺️ **學習路線圖** | NeetCode 150Blind 75 等 | [🔗](https://lufftw.github.io/neetcode/pages/mindmaps/roadmap_paths.html) |
101102

102103
**[→ 探索 10+ 互動式心智圖](https://lufftw.github.io/neetcode/mindmaps/)**
103104

@@ -275,6 +276,8 @@ scripts\run_tests.bat 0001_two_sum
275276

276277
| 語言 | 說明 | 連結 |
277278
|:-----|:-----|:-----|
279+
| **English (Evolved)** | Generated via a multi-agent pipeline | [靜態](docs/mindmaps/neetcode_ontology_agent_evolved_en.md) · [互動式 ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_en.html) |
280+
| **繁體中文 (Evolved)** | 由多代理(multi-agent)流程產生 | [靜態](docs/mindmaps/neetcode_ontology_agent_evolved_zh-TW.md) · [互動式 ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html) |
278281
| **English** | AI 合成的模式關聯 | [靜態](docs/mindmaps/neetcode_ontology_ai_en.md) · [互動式 ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_en.html) |
279282
| **繁體中文** | AI 智能分析模式關聯 | [靜態](docs/mindmaps/neetcode_ontology_ai_zh-TW.md) · [互動式 ✨](https://lufftw.github.io/neetcode/pages/mindmaps/neetcode_ontology_ai_zh-TW.html) |
280283

@@ -306,91 +309,33 @@ scripts\run_tests.bat 0001_two_sum
306309

307310
## 🤖 AI 心智圖生成
308311

309-
> **「軟體架構師的系統思維、演算法教授的教學智慧、資深工程師的實戰經驗,以及競程冠軍的模式識別能力 — 透過 AI 統一合成。」**
310-
311-
### 願景
312-
313-
傳統演算法學習資源孤立呈現知識。我們的 **AI 本體論分析器** 採用根本不同的方法:
314-
315-
| 傳統方法 | 我們的 AI 方法 |
316-
|:---------|:---------------|
317-
| 靜態題目清單 | 動態知識圖譜合成 |
318-
| 手動分類 | AI 發現模式關聯 |
319-
| 單一視角 | 多視角專家合成 |
320-
| 背誦解法 | 理解互聯關係 |
321-
322-
### 運作原理
323-
324-
```
325-
┌─────────────────────────────────────────────────────────────────┐
326-
│ 知識圖譜輸入 │
327-
├─────────────────────────────────────────────────────────────────┤
328-
│ ontology/ │ meta/problems/ │ docs/patterns/ │
329-
│ ├── api_kernels │ ├── 0001_*.toml │ ├── sliding_window │
330-
│ ├── patterns │ ├── 0003_*.toml │ └── ... │
331-
│ ├── algorithms │ └── ... │ │
332-
│ └── ... │ │ │
333-
└─────────────────────┴─────────────────────┴─────────────────────┘
334-
335-
336-
┌─────────────────────────────────────────────────────────────────┐
337-
│ AI 合成引擎 │
338-
├─────────────────────────────────────────────────────────────────┤
339-
│ 🏗️ 軟體架構師 → 系統級模式組織 │
340-
│ 📚 演算法教授 → 教學結構與進程 │
341-
│ ⚙️ 資深工程師 → 實用性與權衡分析 │
342-
│ 🏆 競程冠軍 → 模式識別捷徑 │
343-
│ 🎨 API 設計師 → 清晰的知識介面 │
344-
└─────────────────────────────────────────────────────────────────┘
345-
346-
347-
┌─────────────────────────────────────────────────────────────────┐
348-
│ 智能輸出 │
349-
├─────────────────────────────────────────────────────────────────┤
350-
│ ✅ 智能連結:GitHub 解答(如有)→ LeetCode 後備 │
351-
│ ✅ 多語言:EN / 繁體中文 / 简体中文 │
352-
│ ✅ Markmap 格式:互動式、可摺疊、美觀 │
353-
│ ✅ 自訂目標:面試準備 / 系統學習 / 複習 │
354-
└─────────────────────────────────────────────────────────────────┘
355-
```
356-
357-
### 快速開始
358-
359-
```bash
360-
# 互動模式(推薦)
361-
python tools/generate_mindmaps_ai.py
362-
363-
# 指定目標
364-
python tools/generate_mindmaps_ai.py --goal interview # 面試準備
365-
python tools/generate_mindmaps_ai.py --goal systematic # 學習路線圖
366-
python tools/generate_mindmaps_ai.py --goal pattern_mastery # 深度模式分析
312+
> **「讓 AI 合成人類需要數年才能內化的知識。」**
367313
368-
# 聚焦特定主題
369-
python tools/generate_mindmaps_ai.py --topic sliding_window
370-
python tools/generate_mindmaps_ai.py --topic dynamic_programming
314+
### 兩種生成模式
371315

372-
# 多語言
373-
# 在 tools/mindmap_ai_config.toml 中配置:
374-
# language = ["en", "zh-TW"]
375-
```
316+
| 模式 | 說明 | 快速開始 |
317+
|:-----|:-----|:---------|
318+
| **🤖 Evolved Agent** | 多專家精煉與共識投票 | `cd tools/ai-markmap-agent && python main.py` |
319+
| **🤖 Basic AI** | 從知識圖譜單次合成 | `python tools/generate_mindmaps_ai.py` |
376320

377-
### 配置
321+
### 主要特色
378322

379-
編輯 `tools/mindmap_ai_config.toml` 進行自訂:
323+
- 🧬 **多專家合成** — 架構師 + 教授 + 工程師視角
324+
- 🎯 **智能連結** — GitHub 解答(如有)→ LeetCode 後備
325+
- 🌐 **多語言** — EN / 繁體中文
326+
- ♻️ **可重新生成** — 版本歷史自動遞增
380327

381-
| 區段 | 可配置內容 |
382-
|:-----|:-----------|
383-
| `[model]` | LLM 模型、temperature、max tokens |
384-
| `[output]` | 目錄、檔名、HTML 生成 |
385-
| `[ontology]` | 包含哪些知識圖譜資料 |
386-
| `[problems]` | 問題篩選(難度、主題、路線圖) |
387-
| `[generation]` | 目標、風格、自訂指令 |
388-
| `[links]` | GitHub repo URL、分支、連結格式 |
389-
| `[advanced]` | 輸出語言、複雜度包含 |
328+
### 輸出檔案
390329

391-
### 沒有 API Key?沒問題
330+
| 類型 | 輸出路徑 |
331+
|:-----|:---------|
332+
| **Evolved** | `docs/mindmaps/neetcode_ontology_agent_evolved_{lang}.md` |
333+
| **Basic** | `docs/mindmaps/neetcode_ontology_ai_{lang}.md` |
334+
| **HTML** | `docs/pages/mindmaps/*.html` |
392335

393-
生成器會將完整提示詞儲存到 `tools/prompts/generated/mindmap_prompt.md`。複製並貼到 ChatGPT、Claude 或任何 LLM 網頁介面。
336+
> 📖 **Evolved Agent**:詳見 [`tools/ai-markmap-agent/README.md`](tools/ai-markmap-agent/README.md) 了解架構、專家角色與配置。
337+
>
338+
> 📖 **Basic AI**:詳見 [`tools/README.md`](tools/README.md) 了解配置選項。
394339
395340
---
396341

@@ -980,13 +925,48 @@ python tools/generate_mindmaps.py --html
980925

981926
配置檔:`tools/generate_mindmaps.toml`
982927

928+
### 本地建置文件
929+
930+
> ⚠️ **選擇性功能:** 本地建置文件是**完全選擇性**的。核心 LeetCode 練習功能無需任何文件建置設定即可運作。
931+
932+
**推薦方法(簡單):**
933+
934+
最簡單的本地建置文件方式是使用手動腳本:
935+
936+
```bash
937+
# Windows
938+
scripts\build_docs.bat
939+
940+
# Linux/macOS
941+
./scripts/build_docs.sh
942+
943+
# 建置並本地預覽
944+
scripts\build_docs.bat --serve # Windows
945+
./scripts/build_docs.sh --serve # Linux/macOS
946+
```
947+
948+
📖 **詳見 [本地建置文件(手動方法)](docs/BUILD_DOCS_MANUAL.md)** 完整指南。
949+
950+
**進階選項(選擇性):**
951+
952+
如果你想在本地測試完全相同的 GitHub Actions 工作流程,可以使用 `act`
953+
954+
📖 **詳見 [使用 Act 在本地執行 GitHub Actions](docs/ACT_LOCAL_GITHUB_ACTIONS.md)***注意:需要 Docker 和 act 工具。只有在你想測試 CI/CD 工作流程時才需要。*
955+
983956
### 文件
984957

958+
**核心文件:**
985959
- [`.dev/README.md`](https://github.com/lufftw/neetcode/blob/main/.dev/README.md) — 維護者指南
986960
- [`.dev/TESTING.md`](https://github.com/lufftw/neetcode/blob/main/.dev/TESTING.md) — 測試文件
987961
- [`docs/SOLUTION_CONTRACT.md`](docs/SOLUTION_CONTRACT.md) — 解答檔案規格(SOLUTIONS dict, JUDGE_FUNC)
988962
- [`docs/GENERATOR_CONTRACT.md`](docs/GENERATOR_CONTRACT.md) — 生成器檔案規格(generate(), edge cases, complexity)
989963
- [`docs/ARCHITECTURE_MIGRATION.md`](docs/ARCHITECTURE_MIGRATION.md) — 多型架構遷移指南
964+
965+
**本地文件建置(選擇性):**
966+
- [`docs/BUILD_DOCS_MANUAL.md`](docs/BUILD_DOCS_MANUAL.md) — ⭐ **推薦:** 簡單的手動建置方法
967+
- [`docs/ACT_LOCAL_GITHUB_ACTIONS.md`](docs/ACT_LOCAL_GITHUB_ACTIONS.md) — 進階:使用 act 在本地測試 CI/CD 工作流程(需要 Docker)
968+
969+
**部署:**
990970
- [`docs/GITHUB_PAGES_SETUP.md`](docs/GITHUB_PAGES_SETUP.md) — 部署指南
991971

992972
---

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,13 @@ nav:
105105
- 📐 Patterns:
106106
- Overview: patterns/README.md
107107
- Sliding Window: patterns/sliding_window.md
108+
- Two Pointers: patterns/two_pointers.md
108109
- 🧠 Mind Maps:
109110
- Overview: mindmaps/index.md
110111
- AI Analysis (English): mindmaps/neetcode_ontology_ai_en.md
111112
- AI Analysis (繁體中文): mindmaps/neetcode_ontology_ai_zh-TW.md
113+
- Agent Evolved (English): mindmaps/neetcode_ontology_agent_evolved_en.md
114+
- Agent Evolved (繁體中文): mindmaps/neetcode_ontology_agent_evolved_zh-TW.md
112115
- Pattern Hierarchy: mindmaps/pattern_hierarchy.md
113116
- Family Derivation: mindmaps/family_derivation.md
114117
- Algorithm Usage: mindmaps/algorithm_usage.md
@@ -122,10 +125,13 @@ nav:
122125
- Solution Contract: SOLUTION_CONTRACT.md
123126
- Generator Contract: GENERATOR_CONTRACT.md
124127
- Architecture Migration: ARCHITECTURE_MIGRATION.md
128+
- Ontology Design: ONTOLOGY_DESIGN.md
125129
- 🔧 Guides:
126130
- GitHub Pages Setup: GITHUB_PAGES_SETUP.md
127131
- Build Documentation Locally (Manual): BUILD_DOCS_MANUAL.md
132+
- Local Docs Build Options: LOCAL_DOCS_BUILD.md
128133
- Run GitHub Actions Locally (Act): ACT_LOCAL_GITHUB_ACTIONS.md
134+
- MkDocs Content Guide: MKDOCS_CONTENT_GUIDE.md
129135

130136
# Extra
131137
extra:

0 commit comments

Comments
 (0)