Skip to content

Commit 9696daf

Browse files
committed
docs(features): explain the Claude Code integration from a user view
The "Editors and agents" feature page named only two of the five Claude Code plugins and gave no path to install or use them. Rework the page so the agent story gets concrete, user-facing coverage: - Lead with the shared-engine payoff for editor and agent together. - Describe what each plugin does for the user: mdsmith-lsp, mdsmith-autofix, the three slash commands, the markdown-reviewer subagent, and the markdown-audit skill. - Add the one marketplace-register line and link to the install guide's Claude Code section for per-plugin setup. - Note mdsmith makes no network call of its own, linking telemetry. Refresh the summary, which cascades into the CLAUDE.md catalog and the AGENTS.md / copilot-instructions includes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K1ba2VNTt2KcoVSwmRMBvz
1 parent 86dc716 commit 9696daf

4 files changed

Lines changed: 47 additions & 20 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ row: "- [{summary}](../{filename})"
8383
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](../docs/features/config-transparency.md)
8484
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](../docs/features/cross-file-integrity.md)
8585
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](../docs/features/dependency-graph.md)
86-
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](../docs/features/editor-agent-integration.md)
86+
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](../docs/features/editor-agent-integration.md)
8787
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](../docs/features/file-kinds-schemas.md)
8888
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](../docs/features/git-native.md)
8989
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](../docs/features/index.md)

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ row: "- [{summary}]({filename})"
8989
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
9090
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
9191
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
92-
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
92+
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
9393
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
9494
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
9595
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ row: "- [{summary}]({filename})"
7575
- [Config layers deep-merge rule by rule: defaults, convention, kinds, then overrides. `--explain` and `mdsmith kinds resolve` show which layer set each effective value, per leaf.](docs/features/config-transparency.md)
7676
- [Built-in rules flag broken links and missing anchors, enforce per-file section schemas, and keep Markdown in the right folders. Schemas can be inline on a file kind or shared via `proto.md` files.](docs/features/cross-file-integrity.md)
7777
- [`mdsmith deps` lists what a file pulls in — includes, catalogs, build inputs, and links — or, with `--incoming`, every file that points at it. The LSP call-hierarchy walks the same graph in your editor.](docs/features/dependency-graph.md)
78-
- [A bundled VS Code extension and Claude Code plugins drive the same `mdsmith lsp` server, so diagnostics, fix-on-save, and navigation reach your editor and your coding agent unchanged.](docs/features/editor-agent-integration.md)
78+
- [A VS Code extension and Claude Code plugins run the same rule engine, so diagnostics, quick-fixes, and navigation reach your editor and your agent.](docs/features/editor-agent-integration.md)
7979
- [Tag each file with a `kind`, then validate its headings and front matter against a schema declared inline on the kind or shared via a `proto.md` template — so a whole directory obeys one contract.](docs/features/file-kinds-schemas.md)
8080
- [A Git merge driver auto-resolves conflicts inside generated blocks, and a pre-merge-commit hook re-runs `mdsmith fix` and re-stages the result, so generated content never blocks a merge.](docs/features/git-native.md)
8181
- [The mdsmith feature overview shared by the repository README and the website. Each capability links to a fuller page with rules and examples.](docs/features/index.md)
Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
---
22
title: "Editors and agents"
33
summary: >-
4-
A bundled VS Code extension and Claude Code plugins drive the same
5-
`mdsmith lsp` server, so diagnostics, fix-on-save, and navigation
6-
reach your editor and your coding agent unchanged.
4+
A VS Code extension and Claude Code plugins run the same rule
5+
engine, so diagnostics, quick-fixes, and navigation reach your
6+
editor and your agent.
77
icon: plug
88
link: "/guides/editors/vscode/"
99
weight: 4
1010
group: "One engine, every surface"
1111
---
1212
# Editors and agents
1313

14-
The rule engine is the same everywhere. The value is getting it
15-
into the tools you already use without a separate config.
14+
mdsmith runs one rule engine everywhere. The check that gates a
15+
merge in CI is the same one your editor shows you. Your coding
16+
agent sees that same check as it edits your Markdown. No second
17+
config, no second ruleset.
1618

1719
<?include
1820
file: ../brand/messaging.md
@@ -21,18 +23,43 @@ extract: vscode-overview.text
2123
The extension is a thin LSP client over the bundled mdsmith binary, which it runs with the lsp subcommand. Diagnostics appear inline as squiggles, and every fixable rule contributes a lightbulb quick fix. A whole-buffer fix action runs on demand or on save, with an optional Refactor Preview before edits land. Cross-file navigation extends to Go to Definition, Find All References, workspace symbol search, and a call hierarchy across includes, catalogs, builds, and Markdown links. The mdsmith Command Palette runs Initialize Config, Fix All Markdown, Install Git Merge Driver, Explain Rule on This File, and Show Resolved Config. The .vsix bundles the mdsmith binary for every supported OS and architecture, so no separate install is needed.
2224
<?/include?>
2325

24-
The same `.vsix` is published to Open VSX, so Cursor, VSCodium,
25-
Theia, and Gitpod install it too.
26+
The same `.vsix` ships on Open VSX, so Cursor, VSCodium, Theia,
27+
and Gitpod install it too. The
28+
[Obsidian plugin](../guides/editors/obsidian.md) runs the engine
29+
as WebAssembly, on desktop and mobile.
2630

27-
The Claude Code plugin marketplace ships `mdsmith-lsp`, which
28-
feeds the same diagnostics and navigation to the agent, plus a
29-
Markdown-organization audit skill. The agent sees mdsmith inline
30-
while it edits your docs.
31+
In Claude Code, mdsmith shows the agent the same diagnostics CI
32+
runs: broken links, missing anchors, and heading or schema
33+
violations. The agent catches and fixes them as it writes, before
34+
the change reaches your review.
3135

32-
Pair the plugin with the [progressive disclosure
33-
guide](../guides/progressive-disclosure.md): a `<?catalog?>`
34-
keeps `CLAUDE.md` a one-line-per-doc index of your docs tree.
36+
The marketplace ships five plugins. `mdsmith-lsp` gives the agent
37+
inline diagnostics and the navigation the editor gets.
38+
`mdsmith-autofix` runs `mdsmith fix` after every Markdown edit, so
39+
generated sections and formatting stay correct with no manual
40+
step. Three slash commands run the CLI from the prompt:
41+
`/mdsmith-fix`, `/mdsmith-check`, and `/mdsmith-kinds`. A
42+
`markdown-reviewer` subagent reviews Markdown PRs and drafts for
43+
structural drift. The `/markdown-audit` skill audits a
44+
repository's file layout: hand-kept indexes, missing kinds, and
45+
absent schemas.
3546

36-
See the [VS Code guide](../guides/editors/vscode.md), the
37-
[Obsidian guide](../guides/editors/obsidian.md), and the
38-
[install guide](../guides/install.md) for setup.
47+
Register the marketplace once, then install the plugins you want:
48+
49+
```text
50+
/plugin marketplace add jeduden/mdsmith
51+
```
52+
53+
The [install guide](../guides/install.md#claude-code-plugins)
54+
lists the per-plugin install commands and prerequisites. mdsmith
55+
makes no network call of its own; each plugin only runs the local
56+
binary (see the [telemetry policy](../reference/telemetry.md)).
57+
58+
Pair the plugins with
59+
[progressive disclosure](../guides/progressive-disclosure.md). A
60+
`<?catalog?>` in `CLAUDE.md` keeps one summary line per tracked
61+
doc. The agent reads that index up front, then opens only the
62+
files a task touches.
63+
64+
See the [VS Code guide](../guides/editors/vscode.md) and the
65+
[Obsidian guide](../guides/editors/obsidian.md) for editor setup.

0 commit comments

Comments
 (0)