Skip to content

Commit f7c9862

Browse files
kcenonkcenon
committed
docs(index): add .index/ for LLM document navigation
Adapted from steamliner/docs/.index/ pattern. Provides a 4-file indexing system to load only the documents needed for a query: - manifest.yaml: catalog (IDs, titles, keywords, line counts) - router.yaml: intent/identifier routes to minimum doc set - graph.yaml: change impact cascade + Korean mirror pairs - bundles.yaml: feature-oriented document bundles
1 parent 2be09bd commit f7c9862

4 files changed

Lines changed: 193 additions & 0 deletions

File tree

โ€Ždocs/.index/bundles.yamlโ€Ž

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Database System Document Bundles โ€” load a bundle to get all context for a feature.
2+
_meta: {schema: "1.0.0", generated: "2026-04-12"}
3+
4+
quickstart:
5+
name: "Quickstart"
6+
files: [README.md, GETTING_STARTED.md, API_QUICK_REFERENCE.md]
7+
8+
api-core:
9+
name: "Core API Reference"
10+
files: [API_REFERENCE.md, API_QUICK_REFERENCE.md, FEATURES_ORM_QUERY.md, FEATURES_POOLING_SECURITY.md]
11+
12+
architecture:
13+
name: "Architecture"
14+
files: [ARCHITECTURE.md, PROJECT_STRUCTURE.md, FEATURES_BACKENDS.md]
15+
16+
orm:
17+
name: "ORM (Object-Relational Mapping)"
18+
files: [ORM_GUIDE.md, FEATURES_ORM_QUERY.md, API_REFERENCE.md]
19+
20+
query-builder:
21+
name: "Query Builder"
22+
files: [FEATURES_ORM_QUERY.md, API_REFERENCE.md, API_QUICK_REFERENCE.md]
23+
24+
connection-pool:
25+
name: "Connection Pool"
26+
files: [FEATURES_POOLING_SECURITY.md, API_REFERENCE.md]
27+
28+
security:
29+
name: "Security (TLS / auth / encryption)"
30+
files: [FEATURES_POOLING_SECURITY.md]
31+
32+
adapter:
33+
name: "Adapter Patterns"
34+
files: [ADAPTER_PATTERNS.md, BACKENDS.md, FEATURES_BACKENDS.md]
35+
36+
backends:
37+
name: "Supported Backends"
38+
desc: "PostgreSQL, MySQL, SQLite, and more"
39+
files: [BACKENDS.md, FEATURES_BACKENDS.md, ADAPTER_PATTERNS.md]
40+
41+
transactions:
42+
name: "Transactions"
43+
files: [API_REFERENCE.md, FEATURES_ORM_QUERY.md]
44+
45+
migration:
46+
name: "Migration from database_base"
47+
files: [MIGRATION_database_base.md, CHANGELOG.md]
48+
49+
performance:
50+
name: "Performance & Benchmarks"
51+
files: [BENCHMARKS.md]
52+
53+
quality-assurance:
54+
name: "Quality Assurance"
55+
files: [PRODUCTION_QUALITY.md, BENCHMARKS.md]
56+
57+
compliance:
58+
name: "Compliance (SOUP / Traceability)"
59+
files: [SOUP.md, TRACEABILITY.md]

โ€Ždocs/.index/graph.yamlโ€Ž

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Database System Change Impact Graph โ€” when X changes, review Y.
2+
_meta: {schema: "1.0.0", generated: "2026-04-12"}
3+
4+
cascade:
5+
DB-ARCH-001:
6+
targets:
7+
- {doc: DB-API-001, why: "API surface depends on architecture"}
8+
- {doc: DB-PROJ-001, why: "Directory mirrors architecture"}
9+
- {doc: DB-FEAT-BE, why: "Backend features align with architecture"}
10+
- {doc: DB-G-ADPT, why: "Adapter patterns derived from architecture"}
11+
12+
DB-API-001:
13+
targets:
14+
- {doc: DB-API-QR, why: "Quick reference"}
15+
- {doc: DB-API-KR, why: "Korean mirror"}
16+
- {doc: DB-FEAT-ORM, why: "ORM features implemented via API"}
17+
- {doc: DB-FEAT-PS, why: "Pooling/security features via API"}
18+
- {doc: DB-GS-001, why: "Getting Started uses API"}
19+
20+
DB-FEAT-ORM:
21+
targets:
22+
- {doc: DB-G-ORM, why: "ORM guide references ORM features"}
23+
- {doc: DB-API-001, why: "ORM uses query/transaction API"}
24+
- {doc: DB-FEAT-KR, why: "Korean features mirror"}
25+
26+
DB-FEAT-BE:
27+
targets:
28+
- {doc: DB-G-BE, why: "Backend guide references backend features"}
29+
- {doc: DB-G-ADPT, why: "Adapter patterns handle backend differences"}
30+
31+
DB-FEAT-PS:
32+
targets:
33+
- {doc: DB-API-001, why: "Pool and security API"}
34+
- {doc: DB-QUAL-001, why: "Security validated in quality report"}
35+
36+
DB-G-MIG:
37+
targets:
38+
- {doc: DB-CHG-001, why: "Migration notes in changelog"}
39+
- {doc: DB-API-001, why: "Migration may affect API"}
40+
41+
DB-QUAL-001:
42+
targets:
43+
- {doc: DB-QUAL-KR, why: "Korean mirror"}
44+
- {doc: DB-BENCH, why: "Quality references benchmarks"}
45+
46+
korean_pairs:
47+
- {en: DB-DOC-IDX, kr: DB-DOC-KR}
48+
- {en: DB-ARCH-001, kr: DB-ARCH-KR}
49+
- {en: DB-API-001, kr: DB-API-KR}
50+
- {en: DB-FEAT-ORM, kr: DB-FEAT-KR}
51+
- {en: DB-PROJ-001, kr: DB-PROJ-KR}
52+
- {en: DB-CHG-001, kr: DB-CHG-KR}
53+
- {en: DB-QUAL-001, kr: DB-QUAL-KR}
54+
- {en: DB-BENCH, kr: DB-BENCH-KR}
55+
56+
external_deps:
57+
- {source: common_system, target: DB-ARCH-001, why: "database_system depends on common_system"}
58+
- {source: thread_system, target: DB-ARCH-001, why: "async connections use thread pool"}

โ€Ždocs/.index/manifest.yamlโ€Ž

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Database System Document Manifest โ€” read this FIRST, then load only needed sections.
2+
_meta: {schema: "1.0.0", generated: "2026-04-12", docs: 29, project: "database_system", tier: 3}
3+
4+
core:
5+
- {id: DB-DOC-IDX, file: README.md, title: "Project README", keywords: [index, overview], lines: 195}
6+
- {id: DB-DOC-KR, file: README.kr.md, title: "README (ํ•œ๊ตญ์–ด)", keywords: [index, korean], lines: 287, mirrors: DB-DOC-IDX}
7+
- {id: DB-ARCH-001, file: ARCHITECTURE.md, title: "Architecture", keywords: [architecture, adapters, orm, pooling, layers], lines: 445}
8+
- {id: DB-ARCH-KR, file: ARCHITECTURE.kr.md, title: "์•„ํ‚คํ…์ฒ˜ (ํ•œ๊ตญ์–ด)", keywords: [architecture, korean], lines: 406, mirrors: DB-ARCH-001}
9+
- {id: DB-API-001, file: API_REFERENCE.md, title: "API Reference", keywords: [api, query, transaction, connection, pool], lines: 1245}
10+
- {id: DB-API-KR, file: API_REFERENCE.kr.md, title: "API ์ฐธ์กฐ (ํ•œ๊ตญ์–ด)", keywords: [api, korean], lines: 978, mirrors: DB-API-001}
11+
- {id: DB-API-QR, file: API_QUICK_REFERENCE.md, title: "API Quick Reference", keywords: [api, cheatsheet], lines: 360}
12+
- {id: DB-FEAT-IDX, file: FEATURES.md, title: "Features (index)", keywords: [features, index], lines: 28}
13+
- {id: DB-FEAT-KR, file: FEATURES.kr.md, title: "๊ธฐ๋Šฅ (ํ•œ๊ตญ์–ด)", keywords: [features, korean], lines: 1127, mirrors: DB-FEAT-ORM}
14+
- {id: DB-FEAT-BE, file: FEATURES_BACKENDS.md, title: "Features โ€” Backends", keywords: [features, backends, postgres, sqlite, mysql], lines: 299}
15+
- {id: DB-FEAT-ORM, file: FEATURES_ORM_QUERY.md, title: "Features โ€” ORM & Query", keywords: [features, orm, query, builder], lines: 594}
16+
- {id: DB-FEAT-PS, file: FEATURES_POOLING_SECURITY.md, title: "Features โ€” Pooling & Security", keywords: [features, pool, connection, security, tls], lines: 855}
17+
- {id: DB-PROJ-001, file: PROJECT_STRUCTURE.md, title: "Project Structure", keywords: [structure, directory], lines: 898}
18+
- {id: DB-PROJ-KR, file: PROJECT_STRUCTURE.kr.md, title: "ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ (ํ•œ๊ตญ์–ด)", keywords: [structure, korean], lines: 653, mirrors: DB-PROJ-001}
19+
- {id: DB-CHG-001, file: CHANGELOG.md, title: "Changelog", keywords: [changelog], lines: 1110}
20+
- {id: DB-CHG-KR, file: CHANGELOG.kr.md, title: "๋ณ€๊ฒฝ ์ด๋ ฅ (ํ•œ๊ตญ์–ด)", keywords: [changelog, korean], lines: 1007, mirrors: DB-CHG-001}
21+
- {id: DB-GS-001, file: GETTING_STARTED.md, title: "Getting Started", keywords: [getting-started], lines: 434}
22+
23+
guides:
24+
- {id: DB-G-ORM, file: ORM_GUIDE.md, title: "ORM Guide", keywords: [orm, guide, model, mapping], lines: 676}
25+
- {id: DB-G-ADPT, file: ADAPTER_PATTERNS.md, title: "Adapter Patterns", keywords: [adapter, patterns, integration], lines: 720}
26+
- {id: DB-G-BE, file: BACKENDS.md, title: "Backends", keywords: [backends, database-types, drivers], lines: 189}
27+
- {id: DB-G-MIG, file: MIGRATION_database_base.md, title: "Migration from database_base", keywords: [migration, upgrade, legacy], lines: 305}
28+
29+
quality:
30+
- {id: DB-QUAL-001, file: PRODUCTION_QUALITY.md, title: "Production Quality", keywords: [quality, sanitizers], lines: 685}
31+
- {id: DB-QUAL-KR, file: PRODUCTION_QUALITY.kr.md, title: "ํ”„๋กœ๋•์…˜ ํ’ˆ์งˆ (ํ•œ๊ตญ์–ด)", keywords: [quality, korean], lines: 387, mirrors: DB-QUAL-001}
32+
- {id: DB-BENCH, file: BENCHMARKS.md, title: "Benchmarks", keywords: [benchmarks, performance, latency], lines: 663}
33+
- {id: DB-BENCH-KR, file: BENCHMARKS.kr.md, title: "๋ฒค์น˜๋งˆํฌ (ํ•œ๊ตญ์–ด)", keywords: [benchmarks, korean], lines: 558, mirrors: DB-BENCH}
34+
35+
reference:
36+
- {id: DB-ECO, file: ECOSYSTEM.md, title: "Ecosystem", keywords: [ecosystem], lines: 28}
37+
- {id: DB-SOUP, file: SOUP.md, title: "SOUP", keywords: [soup], lines: 124}
38+
- {id: DB-TRACE, file: TRACEABILITY.md, title: "Traceability", keywords: [traceability], lines: 133}
39+
40+
load_patterns:
41+
quick_start: [DB-DOC-IDX, DB-GS-001, DB-API-QR]
42+
architecture_review: [DB-ARCH-001, DB-PROJ-001, DB-FEAT-BE]
43+
api_deep: [DB-API-001, DB-FEAT-ORM, DB-FEAT-PS]
44+
orm_work: [DB-G-ORM, DB-FEAT-ORM, DB-API-001]
45+
pool_work: [DB-FEAT-PS, DB-API-001]
46+
backend_work: [DB-G-BE, DB-FEAT-BE, DB-G-ADPT]
47+
security_work: [DB-FEAT-PS]
48+
quality_audit: [DB-QUAL-001, DB-BENCH]
49+
migration_work: [DB-G-MIG, DB-CHG-001]

โ€Ždocs/.index/router.yamlโ€Ž

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Database System Query Router โ€” match query to minimum document set.
2+
_meta: {schema: "1.0.0", generated: "2026-04-12"}
3+
4+
intent_routes:
5+
- {keywords: [getting started, tutorial, install, ์‹œ์ž‘], bundle: quickstart}
6+
- {keywords: [api, reference, ๋ ˆํผ๋Ÿฐ์Šค], bundle: api-core}
7+
- {keywords: [architecture, design, ์•„ํ‚คํ…์ฒ˜], bundle: architecture}
8+
- {keywords: [orm, model, mapping, entity], bundle: orm}
9+
- {keywords: [query, builder, select, insert, update, delete, ์ฟผ๋ฆฌ], bundle: query-builder}
10+
- {keywords: [connection pool, pooling, pool, ์—ฐ๊ฒฐ ํ’€], bundle: connection-pool}
11+
- {keywords: [security, tls, encryption, ๋ณด์•ˆ], bundle: security}
12+
- {keywords: [adapter, pattern, integration, ์–ด๋Œ‘ํ„ฐ], bundle: adapter}
13+
- {keywords: [backend, postgres, mysql, sqlite, driver, ๋ฐฑ์—”๋“œ], bundle: backends}
14+
- {keywords: [transaction, tx, commit, rollback, ํŠธ๋žœ์žญ์…˜], bundle: transactions}
15+
- {keywords: [migration, upgrade, legacy, ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜], bundle: migration}
16+
- {keywords: [benchmark, performance, latency, throughput, ์„ฑ๋Šฅ], bundle: performance}
17+
- {keywords: [quality, sanitizer, ํ’ˆ์งˆ], bundle: quality-assurance}
18+
19+
fallback:
20+
primary: DB-DOC-IDX
21+
secondary: [DB-API-QR, DB-FEAT-ORM]
22+
23+
skip:
24+
- ECOSYSTEM.md
25+
- SOUP.md
26+
- TRACEABILITY.md
27+
- FEATURES.md # 28 lines, index-only

0 commit comments

Comments
ย (0)