Skip to content

Commit 5259c12

Browse files
web-flowclaude
andcommitted
docs: improve navigation and add CI/coverage badges
- Add breadcrumb navigation with root link to all docs - Add terminology index to glossary (JP/EN) - Add CI and Codecov badges to README (JP/EN) - Add version badge to AI Spec Hub - Expand API reference with detailed method docs - Sync English documentation with Japanese updates 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent c2dc738 commit 5259c12

19 files changed

Lines changed: 300 additions & 19 deletions

EpisodicRAG/README.en.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,27 @@ Examples: 2025-07-01_W0001_CognitiveArchitecture.txt
336336

337337
---
338338

339+
## Terminology Index
340+
341+
| Term | Section |
342+
|------|---------|
343+
| base_dir | [Basic Concepts](#base_dir) |
344+
| Cascade | [8-Layer Hierarchy](#hierarchical-cascade) |
345+
| Digest | [Basic Concepts](#digest) |
346+
| Essences | [Basic Concepts](#essences) |
347+
| GrandDigest | [Memory Structure](#granddigest) |
348+
| Loop | [Basic Concepts](#loop) |
349+
| Mottled Memory | [Processes & Operations](#mottled-memory-まだらボケ) |
350+
| paths | [Basic Concepts](#paths) |
351+
| Placeholder | [Processes & Operations](#placeholder) |
352+
| plugin_root | [Basic Concepts](#plugin_root) |
353+
| Provisional Digest | [Memory Structure](#provisional-digest) |
354+
| Regular Digest | [Memory Structure](#regular-digest) |
355+
| ShadowGrandDigest | [Memory Structure](#shadowgranddigest) |
356+
| Threshold | [Processes & Operations](#threshold) |
357+
358+
---
359+
339360
## Related Documents
340361

341362
- [Main README](../README.md) - Project Overview

EpisodicRAG/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,27 @@ L00001追加 → `/digest`せず → L00002追加
336336

337337
---
338338

339+
## 用語インデックス
340+
341+
| 用語 | セクション |
342+
|------|----------|
343+
| base_dir | [基本概念](#base_dir) |
344+
| Cascade | [8階層構造](#階層的カスケード) |
345+
| Digest | [基本概念](#digest) |
346+
| Essences | [基本概念](#essences) |
347+
| GrandDigest | [記憶構造](#granddigest) |
348+
| Loop | [基本概念](#loop) |
349+
| paths | [基本概念](#paths) |
350+
| Placeholder | [プロセス・操作](#プレースホルダー) |
351+
| plugin_root | [基本概念](#plugin_root) |
352+
| Provisional Digest | [記憶構造](#provisional-digest) |
353+
| Regular Digest | [記憶構造](#regular-digest) |
354+
| ShadowGrandDigest | [記憶構造](#shadowgranddigest) |
355+
| Threshold | [プロセス・操作](#threshold閾値) |
356+
| まだらボケ | [プロセス・操作](#まだらボケ) |
357+
358+
---
359+
339360
## 関連ドキュメント
340361

341362
- [メインREADME](../README.md) - プロジェクト概要

EpisodicRAG/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# EpisodicRAG AI Specification Hub
22

3+
[![Version](https://img.shields.io/badge/version-3.0.0-blue.svg)](https://github.com/Bizuayeu/Plugins-Weave)
4+
35
AI/Claudeエージェント向けの技術仕様ハブです。
46

57
> 📖 **ユーザー向けドキュメント**[プロジェクト README](../../README.md) を参照してください。

EpisodicRAG/docs/dev/API_REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Docs](../README.md) > API_REFERENCE
1+
[EpisodicRAG](../../README.md) > [Docs](../README.md) > API_REFERENCE
22

33
# API リファレンス
44

EpisodicRAG/docs/dev/ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Docs](../README.md) > ARCHITECTURE
1+
[EpisodicRAG](../../README.md) > [Docs](../README.md) > ARCHITECTURE
22

33
# Architecture - EpisodicRAG Plugin
44

EpisodicRAG/docs/dev/ERROR_RECOVERY_PATTERNS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[EpisodicRAG](../../README.md) > [Docs](../README.md) > ERROR_RECOVERY_PATTERNS
2+
13
# エラーリカバリーパターン
24

35
EpisodicRAGプラグインで使用されているエラーハンドリングと

EpisodicRAG/docs/dev/api/application.md

Lines changed: 74 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
[API Reference](../API_REFERENCE.md) > Application層
1+
[EpisodicRAG](../../../README.md) > [Docs](../../README.md) > [API](../API_REFERENCE.md) > Application
22

33
# Application層 API
44

55
ビジネスロジックの実装。
66

7+
> 📖 用語・共通概念は [用語集](../../../README.md) を参照
8+
79
```python
810
from application.shadow import ShadowTemplate, ShadowUpdater
911
from application.grand import GrandDigestManager, ShadowGrandDigestManager
@@ -208,10 +210,77 @@ class ShadowUpdater:
208210

209211
## GrandDigest管理(application/grand/)
210212

211-
| クラス | 説明 |
212-
|--------|------|
213-
| `GrandDigestManager` | GrandDigest.txt CRUD操作 |
214-
| `ShadowGrandDigestManager` | ShadowGrandDigest.txt管理 |
213+
### GrandDigestManager
214+
215+
GrandDigest.txt の CRUD操作を担当。
216+
217+
```python
218+
class GrandDigestManager:
219+
def __init__(self, config: DigestConfig): ...
220+
```
221+
222+
| メソッド | 説明 | 例外 |
223+
|---------|------|------|
224+
| `get_template() -> GrandDigestData` | テンプレート生成(全8レベル対応) | - |
225+
| `load_or_create() -> GrandDigestData` | 読み込みまたは新規作成 | `FileIOError` |
226+
| `save(data: GrandDigestData) -> None` | GrandDigest.txtを保存 | `FileIOError` |
227+
| `update_digest(level, digest_name, overall_digest) -> None` | 指定レベルのダイジェスト更新 | `DigestError` |
228+
229+
**使用例**:
230+
231+
```python
232+
from application.grand import GrandDigestManager
233+
from config import DigestConfig
234+
235+
config = DigestConfig()
236+
manager = GrandDigestManager(config)
237+
238+
# テンプレート取得
239+
template = manager.get_template()
240+
241+
# 読み込みまたは作成
242+
data = manager.load_or_create()
243+
244+
# ダイジェスト更新
245+
manager.update_digest("weekly", "W0001_タイトル", overall_digest_data)
246+
```
247+
248+
### ShadowGrandDigestManager
249+
250+
ShadowGrandDigest.txt 管理のFacade。Shadow更新・カスケード処理を統括。
251+
252+
```python
253+
class ShadowGrandDigestManager:
254+
def __init__(self, config: Optional[DigestConfig] = None): ...
255+
```
256+
257+
| メソッド | 説明 |
258+
|---------|------|
259+
| `add_files_to_shadow(level, new_files) -> None` | Shadowに新規ファイル追加(増分更新) |
260+
| `clear_shadow_level(level) -> None` | 指定レベルのShadow初期化 |
261+
| `get_shadow_digest_for_level(level) -> Optional[OverallDigestData]` | Shadowダイジェスト取得 |
262+
| `promote_shadow_to_grand(level) -> None` | Shadow→Grand昇格 |
263+
| `update_shadow_for_new_loops() -> None` | 新規Loop検出→weekly Shadow更新 |
264+
| `cascade_update_on_digest_finalize(level) -> None` | 確定時カスケード処理 |
265+
266+
**使用例**:
267+
268+
```python
269+
from application.grand import ShadowGrandDigestManager
270+
from config import DigestConfig
271+
272+
config = DigestConfig()
273+
manager = ShadowGrandDigestManager(config)
274+
275+
# 新しいLoopファイルを検出してShadowを更新
276+
manager.update_shadow_for_new_loops()
277+
278+
# Weeklyダイジェスト確定時のカスケード処理
279+
manager.cascade_update_on_digest_finalize("weekly")
280+
281+
# 指定レベルのShadowダイジェストを取得
282+
shadow = manager.get_shadow_digest_for_level("weekly")
283+
```
215284

216285
---
217286

EpisodicRAG/docs/dev/api/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[API Reference](../API_REFERENCE.md) > 設定・Config
1+
[EpisodicRAG](../../../README.md) > [Docs](../../README.md) > [API](../API_REFERENCE.md) > Config
22

33
# 設定 API
44

EpisodicRAG/docs/dev/api/domain.md

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
[API Reference](../API_REFERENCE.md) > Domain層
1+
[EpisodicRAG](../../../README.md) > [Docs](../../README.md) > [API](../API_REFERENCE.md) > Domain
22

33
# Domain層 API
44

55
コアビジネスロジック。外部に依存しない純粋な定義。
66

7+
> 📖 用語・共通概念は [用語集](../../../README.md) を参照
8+
79
```python
810
from domain import (
911
# 定数
@@ -323,4 +325,79 @@ LEVEL_CONFIGから階層関係(source/next)を抽出した辞書を構築。
323325

324326
---
325327

328+
## エラーフォーマット(domain/error_formatter.py)
329+
330+
エラーメッセージの標準化を担当。一貫したパス表記、コンテキスト情報、メッセージフォーマットを提供。
331+
332+
### ErrorFormatter
333+
334+
```python
335+
class ErrorFormatter:
336+
def __init__(self, project_root: Path): ...
337+
```
338+
339+
| メソッド | 説明 |
340+
|---------|------|
341+
| `format_path(path)` | パスを相対パスに正規化 |
342+
343+
#### Level/Config エラー
344+
345+
| メソッド | 説明 |
346+
|---------|------|
347+
| `invalid_level(level, valid_levels)` | 無効レベルエラー |
348+
| `unknown_level(level)` | 不明レベルエラー(`invalid_level`のエイリアス) |
349+
| `config_key_missing(key)` | 設定キー欠落エラー |
350+
| `config_invalid_value(key, expected, actual)` | 設定値不正エラー |
351+
| `config_section_missing(section)` | 設定セクション欠落エラー |
352+
353+
#### File I/O エラー
354+
355+
| メソッド | 説明 |
356+
|---------|------|
357+
| `file_not_found(path)` | ファイル未検出エラー |
358+
| `file_already_exists(path)` | ファイル既存エラー |
359+
| `file_io_error(operation, path, error)` | ファイルI/Oエラー |
360+
| `directory_not_found(path)` | ディレクトリ未検出エラー |
361+
| `directory_creation_failed(path, error)` | ディレクトリ作成失敗エラー |
362+
| `invalid_json(path, error)` | JSON不正エラー |
363+
364+
#### Validation エラー
365+
366+
| メソッド | 説明 |
367+
|---------|------|
368+
| `invalid_type(context, expected, actual)` | 型不正エラー |
369+
| `validation_error(field, reason, value)` | バリデーションエラー |
370+
| `empty_collection(context)` | 空コレクションエラー |
371+
372+
#### Digest固有エラー
373+
374+
| メソッド | 説明 |
375+
|---------|------|
376+
| `digest_not_found(level, identifier)` | ダイジェスト未検出エラー |
377+
| `shadow_empty(level)` | Shadow空エラー |
378+
| `cascade_error(from_level, to_level, reason)` | カスケードエラー |
379+
| `initialization_failed(component, error)` | 初期化失敗エラー |
380+
381+
### ファクトリ関数
382+
383+
```python
384+
def get_error_formatter(project_root: Optional[Path] = None) -> ErrorFormatter
385+
def reset_error_formatter() -> None # テスト用リセット
386+
```
387+
388+
**使用例**:
389+
390+
```python
391+
from domain.error_formatter import get_error_formatter
392+
393+
formatter = get_error_formatter()
394+
msg = formatter.file_not_found(Path("/path/to/file.txt"))
395+
# -> "File not found: path/to/file.txt"
396+
397+
msg = formatter.invalid_level("xyz", ["weekly", "monthly"])
398+
# -> "Invalid level: 'xyz'. Valid levels: weekly, monthly"
399+
```
400+
401+
---
402+
326403
**EpisodicRAG** by Weave | [GitHub](https://github.com/Bizuayeu/Plugins-Weave)

EpisodicRAG/docs/dev/api/infrastructure.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
[API Reference](../API_REFERENCE.md) > Infrastructure層
1+
[EpisodicRAG](../../../README.md) > [Docs](../../README.md) > [API](../API_REFERENCE.md) > Infrastructure
22

33
# Infrastructure層 API
44

55
外部関心事(ファイルI/O、ロギング)。
66

7+
> 📖 用語・共通概念は [用語集](../../../README.md) を参照
8+
79
```python
810
from infrastructure import load_json, save_json, log_info, log_error
911
from infrastructure.file_scanner import scan_files, get_max_numbered_file

0 commit comments

Comments
 (0)