Skip to content

Commit d6b346c

Browse files
mareursclaude
andcommitted
docs(manual): graduate 10 stable features out of experimental
Move pages to their target chapters, strip ⚠ Experimental callouts, and wire into SUMMARY.md proper sections. Remove from experimental/index.md. Graduated: - bash-language-support → concepts/ (Language Support) - mux-rust → concepts/rust-lsp-multiplexer.md (Language Support) - cross-process-write-serialization → concepts/ (Security & Permissions) - mcp-resources → concepts/ (new MCP Resources section) - project-hints → concepts/ (Multi-Project Workspaces) - tool-description-diet → concepts/ (MCP Resources) - tool-usage-doctor → concepts/ (MCP Resources) - file-diversity-rerank → tools/semantic-search-diversity.md - list-symbols-progressive-dir → tools/list-symbols-progressive.md - read-markdown-improvements → tools/read-markdown.md Still experimental: asymmetric-query-prefix, global-config, index-scope-guard, librarian-mcp, metadata-enriched-chunks. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 7483566 commit d6b346c

12 files changed

Lines changed: 13 additions & 51 deletions

docs/manual/src/SUMMARY.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@
3232
- [Auto-Registration](concepts/multi-ecosystem-auto-registration.md)
3333
- [Multi-Project Workspaces](concepts/multi-project-workspace.md)
3434
- [activate_project Output](concepts/activate-project-output-optimization.md)
35+
- [Project Hints](concepts/project-hints.md)
36+
37+
- [MCP Resources](concepts/mcp-resources.md)
38+
- [Tool Description Diet](concepts/tool-description-diet.md)
39+
- [Tool Usage Doctor](concepts/tool-usage-doctor.md)
3540
- [LSP Idle TTL](concepts/lsp-idle-ttl.md)
3641

3742
- [Memory](concepts/memory.md)
@@ -46,6 +51,7 @@
4651
- [Security Profiles](concepts/security-profiles.md)
4752
- [Compact Schemas & `activate_project` Safety](concepts/compact-schemas-and-activate-project-safety.md)
4853
- [PostCompact Cache Flush](concepts/post-compact-cache-flush.md)
54+
- [Cross-Process Write Serialization](concepts/cross-process-write-serialization.md)
4955

5056
- [Routing Plugin](concepts/routing-plugin.md)
5157
- [Superpowers Workflow](concepts/superpowers.md)
@@ -56,20 +62,25 @@
5662
- [Model Comparison](configuration/embedding-model-comparison.md)
5763

5864
- [Language Support](language-support.md)
65+
- [Bash](concepts/bash-language-support.md)
5966
- [Kotlin LSP Multiplexer](concepts/kotlin-lsp-multiplexer.md)
67+
- [Rust LSP Multiplexer](concepts/rust-lsp-multiplexer.md)
6068

6169
# Tool Reference
6270

6371
- [Tools Overview](tools/overview.md)
6472
- [API Naming Reference](tools/api-redesign.md)
6573
- [Symbol Navigation](tools/symbol-navigation.md)
74+
- [Progressive Directory Overview](tools/list-symbols-progressive.md)
6675
- [File Operations](tools/file-operations.md)
6776
- [grep: Literal Fallback](tools/search-pattern-literal-fallback.md)
6877
- [Editing](tools/editing.md)
6978
- [Structural Edit Gate](tools/edit-file-structural-gate.md)
7079
- [Document Section Editing](tools/document-section-editing.md)
7180
- [Markdown Tools](tools/markdown-tools.md)
81+
- [read_markdown](tools/read-markdown.md)
7282
- [Semantic Search](tools/semantic-search.md)
83+
- [File-Diversity Re-Rank](tools/semantic-search-diversity.md)
7384
- [Library Navigation](tools/library-navigation.md)
7485
- [Git](tools/git.md)
7586
- [AST Analysis](tools/ast.md)
@@ -84,20 +95,10 @@
8495

8596
- [Experimental Features](experimental/index.md)
8697
- [Asymmetric query prefix](experimental/asymmetric-query-prefix.md)
87-
- [Bash language support](experimental/bash-language-support.md)
88-
- [Cross-process write serialization](experimental/cross-process-write-serialization.md)
89-
- [File-diversity re-rank](experimental/file-diversity-rerank.md)
9098
- [Global config](experimental/global-config.md)
9199
- [Index scope guard](experimental/index-scope-guard.md)
92100
- [librarian-mcp](experimental/librarian-mcp.md)
93-
- [list_symbols progressive directory](experimental/list-symbols-progressive-dir.md)
94-
- [MCP resources, tool diet, progress](experimental/mcp-resources.md)
95101
- [Metadata-enriched chunks](experimental/metadata-enriched-chunks.md)
96-
- [Project hints](experimental/project-hints.md)
97-
- [read_markdown improvements](experimental/read-markdown-improvements.md)
98-
- [Rust LSP multiplexer](experimental/mux-rust.md)
99-
- [Tool description diet](experimental/tool-description-diet.md)
100-
- [Tool usage doctor](experimental/tool-usage-doctor.md)
101102

102103
# Development
103104

docs/manual/src/experimental/bash-language-support.md renamed to docs/manual/src/concepts/bash-language-support.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Bash language support
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
## What it does
63

74
Bash and shell scripts (`.sh`, `.bash`) now receive full language support:

docs/manual/src/experimental/cross-process-write-serialization.md renamed to docs/manual/src/concepts/cross-process-write-serialization.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Cross-Process Write Serialization
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
When multiple codescout MCP server instances run against the same project directory simultaneously (e.g. two IDE windows, two Claude Code sessions, or a background indexer alongside an active session), write-tool calls are now serialized so they cannot corrupt each other.
63

74
## How It Works

docs/manual/src/experimental/mcp-resources.md renamed to docs/manual/src/concepts/mcp-resources.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# MCP resources, tool diet, and progress notifications
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
Codescout now exposes three mechanisms to reduce per-turn token overhead and
63
surface activity from long-running operations. They ship together because they
74
share one thesis: **pay tokens only when the model asks**.

docs/manual/src/experimental/project-hints.md renamed to docs/manual/src/concepts/project-hints.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Project Hints
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
`activate_project` now returns a `project_hints` field with manifest-derived
63
context so agents have useful information even when `onboarding` has never been
74
run.

docs/manual/src/experimental/mux-rust.md renamed to docs/manual/src/concepts/rust-lsp-multiplexer.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Rust LSP multiplexer
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
## What it does
63

74
When two `codescout` instances open the same Rust project, they now share a

docs/manual/src/experimental/tool-description-diet.md renamed to docs/manual/src/concepts/tool-description-diet.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
> ⚠ Experimental — may change without notice.
21

32
# Tool Description Diet & Tool Guide Resource
43

docs/manual/src/experimental/tool-usage-doctor.md renamed to docs/manual/src/concepts/tool-usage-doctor.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# Tool Usage Doctor
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
The `doctor://tool-usage` MCP resource surfaces per-tool call statistics and
63
prune candidates, so codescout maintainers can quantify what the current
74
token-diet actually bought us and identify rarely-used tools for the next

docs/manual/src/experimental/index.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,7 @@
77
## Available Features
88

99
- [Asymmetric query prefix for embedding models](./asymmetric-query-prefix.md) — automatic query-side prefix for models trained asymmetrically (e.g. CodeRankEmbed), restoring `semantic_search` recall without user configuration.
10-
- [Bash language support](./bash-language-support.md) — full symbol extraction and LSP navigation for `.sh` / `.bash` files via `bash-language-server`.
11-
- [`list_symbols` progressive directory overview](./list-symbols-progressive-dir.md) — adaptive three-mode output (full tree / class overview / directory map) for directory-level symbol queries.
12-
- [MCP resources, tool diet, progress notifications](./mcp-resources.md) — token-efficient resource sharing, short descriptions with on-demand guides, and progress notifications for long operations.
13-
- [Project hints in `activate_project`](./project-hints.md) — manifest-derived primary language, entry points, and build commands surfaced in the activation response so agents have context without running onboarding.
14-
- [`read_markdown` improvements](./read-markdown-improvements.md) — adaptive output tiers, `@file_*` buffer ref support, and heading navigation for large markdown files.
15-
- [Rust LSP multiplexer](./mux-rust.md) — share a single `rust-analyzer` process across multiple `codescout` instances on the same project, eliminating stale-hover / stale-goto bugs.
16-
- [Tool usage doctor](./tool-usage-doctor.md)`doctor://tool-usage` MCP resource reporting per-tool call counts, error/overflow rates, and prune candidates for the next prompt-surface review.
17-
- [Cross-process write serialization](./cross-process-write-serialization.md) — advisory file lock serializes write-tool calls across concurrent codescout instances on the same project; contention returns a recoverable error instead of corrupting files.
10+
- [Global config](./global-config.md)`~/.config/codescout/config.toml` (XDG) merged with per-project `.codescout/config.toml`; set workspace-wide defaults without touching every project.
1811
- [Index Scope Guard](./index-scope-guard.md) — confirmation prompt before `index_project` walks home/system directories or oversized trees.
19-
- [Metadata-Enriched Chunks](./metadata-enriched-chunks.md) — file path, container context, and symbol name prepended to chunk embeddings for better multi-concept keyword query matching.
20-
- [File-Diversity Re-Rank for `semantic_search`](./file-diversity-rerank.md) — per-file cap on semantic search results prevents a single file from saturating the top-K; overfetch-then-filter preserves score ordering.
21-
2212
- [librarian-mcp — workspace artifact registry](./librarian-mcp.md) — sibling MCP server that indexes markdown artifacts (specs, plans, memories, ADRs, docs) across every repo in a workspace, with filter AST, link graph, and semantic search.
23-
- [Tool description diet & tool guide resource](./tool-description-diet.md) — caps tool descriptions at 300 characters; full usage notes served on demand via `doc://codescout-tool-guide` resource.
24-
- [Global config](./global-config.md)`~/.config/codescout/config.toml` (XDG) merged with per-project `.codescout/config.toml`; set workspace-wide defaults without touching every project.
13+
- [Metadata-Enriched Chunks](./metadata-enriched-chunks.md) — file path, container context, and symbol name prepended to chunk embeddings for better multi-concept keyword query matching.

docs/manual/src/experimental/list-symbols-progressive-dir.md renamed to docs/manual/src/tools/list-symbols-progressive.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
# `list_symbols` progressive directory overview
2-
3-
> ⚠ Experimental — may change without notice.
4-
52
## What it does
63

74
When `list_symbols` is called on a directory (rather than a single file), it

0 commit comments

Comments
 (0)