Skip to content

Commit dbc9904

Browse files
committed
docs(agents): deduplicate workspace architecture notes with README links
Condense AGENTS.md lines 35-40 to implementation-only details and link to packages/vscode/README.md for user-facing behavior, settings reference, and known limitations that were previously duplicated. Assisted-by: Claude
1 parent d48a30a commit dbc9904

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Style, file layout, patterns: [CONTRIBUTING.md#conventions](CONTRIBUTING.md#conv
3232

3333
- **Single `file://` workspace folder at the vault root** for Quick Open (`Cmd+P`) and `Ctrl+Shift+F` search. VSCode's file discovery and ripgrep indexer only operate on `file://` workspace folders — `obs://` workspace folders provide zero discoverability (confirmed by spike, 2026-05-15).
3434
- **`files.exclude` patterns** hide non-autoMount vault content to match the Explorer tree view's visibility. Two-tier split: dotfiles + `blocked``ConfigurationTarget.WorkspaceFolder` (`<vault>/.vscode/settings.json`); non-autoMount dirs + file extension globs → `ConfigurationTarget.Workspace`. Tracked in `context.workspaceState`, cleaned up on change or disable. All defaults come from `package.json` (single source of truth).
35-
- **Vault-side exclusion toggles**`vault.excludeDotfiles` + `vault.excludeDotfilePattern` control dotfile hiding; `vault.excludeBlocked` controls blocked-path hiding; `vault.gitIgnore` controls `git.ignoredRepositories` management. Each is independently toggleable at runtime.
36-
- **Sub-path exclusion**when `autoMount` contains nested paths (e.g., `["20-areas/idea"]`), `files.exclude` patterns hide sibling directories (`20-areas/career`, `20-areas/otaviof`) to match tree view visibility. Computed via mount tree (`packages/core/src/mount-tree.ts`). Controlled by `workspace.excludeUnmountedFolders`.
37-
- **File-level exclusion**`obsidianVFS.workspace.excludeUnmountedFilePattern` provides a regex tested against file basenames at partially-mounted levels. Matching files generate `{prefix}/*{ext}` glob patterns in the folder-scoped `files.exclude` tier, hiding Obsidian files (`.md`, `.base`, `.canvas`) from Explorer and Quick Open without affecting same-named files in other workspace folders. Gated by `workspace.excludeUnmountedFiles` toggle. Default: `\\.(md|base|canvas)$`.
38-
- **Vault write protection**`obsidianVFS.vault.mode` controls write access through the `obs://` FileSystemProvider. `"ro"` registers the provider with `isReadonly: true`; `"partial"` enforces autoMount-scoped writes at the provider level. Protection covers tree view operations, drag-and-drop into the tree, and `obs://` editor saves. The `file://` workspace folder (Explorer panel, Quick Open, Search) bypasses the provider entirely — drag-and-drop, rename, delete, and editor saves via `file://` remain writable regardless of vault mode. This gap closes when `FileSearchProvider`/`TextSearchProvider` stabilize.
39-
- **`obs://` FileSystemProvider** remains registered for the Explorer tree view sidebar, wikilinks, drag-and-drop, and watch events — it does not back a workspace folder.
40-
- **`FileSearchProvider`/`TextSearchProvider` are proposed (unstable) APIs** as of `@types/vscode@1.118.0`. When stabilized, the extension can switch to a single `obs://` workspace folder with native search, eliminating the `files.exclude` workaround. Check `@types/vscode` for stable availability — do not use while proposed.
35+
- **Vault-side exclusion toggles**`vault.excludeDotfiles`, `vault.excludeDotfilePattern`, `vault.excludeBlocked`, `vault.gitIgnore`. Each independently toggleable at runtime. Settings reference: [README.md § Vault](packages/vscode/README.md#vault).
36+
- **Sub-path exclusion**computed via mount tree (`packages/core/src/mount-tree.ts`). Controlled by `workspace.excludeUnmountedFolders`.
37+
- **File-level exclusion** — regex on basenames generates `{prefix}/*{ext}` globs in the folder-scoped `files.exclude` tier. Gated by `workspace.excludeUnmountedFiles` toggle.
38+
- **Vault write protection**`vault.mode` controls `obs://` writes (`"ro"` `isReadonly: true`; `"partial"` autoMount-scoped enforcement). The `file://` workspace folder bypasses the provider. Limitations: [README.md § Workspace Folder](packages/vscode/README.md#workspace-folder).
39+
- **`obs://` FileSystemProvider** registered for tree view, wikilinks, drag-and-drop, watch events; does not back a workspace folder.
40+
- **`FileSearchProvider`/`TextSearchProvider`** proposed (unstable) as of `@types/vscode@1.118.0`. Do not use while proposed. Details: [README.md § Workspace Folder](packages/vscode/README.md#workspace-folder).
4141

4242
## Documentation
4343

0 commit comments

Comments
 (0)