Skip to content

Commit 64136b2

Browse files
author
Alex
committed
docs: update project-level config discovery documentation
- Add project-level config discovery section to terraphim_config summary - Update main summary.md with new ProjectConfig type and discovery feature - Add release announcement to .docs/releases/v2026.05.19.md Refs: project config discovery feature (commits 59cd233, 26f5b87)
1 parent af9f0f5 commit 64136b2

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

.docs/summary-crates-terraphim_config-src-lib.rs.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
2. Saved config retrieved from persistence layer
88
3. Hard-coded defaults in `terraphim_server/default/`
99

10+
**Project-Level Config Discovery:**
11+
- Searches parent directories for `.terraphim/` directory starting from current working directory
12+
- Enables project-specific roles, global shortcuts, and configuration overrides
13+
- Merged with global config via `Config::with_project()` and `Config::merge_with()`
14+
- Roles merged by `RoleName`: project role fully replaces global role (no deep merge)
15+
- `global_shortcut` field is optional in project configs
16+
1017
**Key Types:**
1118
- **`Config`**: Top-level configuration holding all roles, global shortcut, default/selected role
1219
- **`Role`**: User profile with haystacks, relevance function, theme, LLM settings

.docs/summary.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ User Query
9797
- `Role`: User profile with haystacks, relevance function, theme, LLM settings
9898
- `Haystack`: Data source descriptor with service type
9999
- `KnowledgeGraph`: Automata path and/or local KG files
100+
- `ProjectConfig`: Project-level overrides in `.terraphim/config.json`
101+
102+
**Project-Level Config Discovery:**
103+
- Searches parent directories for `.terraphim/` directory starting from CWD
104+
- Enables project-specific roles, global shortcuts, and configuration overrides
105+
- Merged with global config via `Config::with_project()` and `Config::merge_with()`
106+
- Roles merged by `RoleName`: project role fully replaces global role
107+
- Optional `global_shortcut` field allows project configs to omit it
100108

101109
**Service Types Supported:**
102110
- Ripgrep, Atomic Server, QueryRs, ClickUp, MCP, Perplexity, GrepApp, AiAssistant, Quickwit, JMAP

0 commit comments

Comments
 (0)