@theglitchking/hit-em-with-the-docs 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/README.md +41 -0
- package/package.json +1 -1
|
@@ -6,13 +6,13 @@
|
|
|
6
6
|
},
|
|
7
7
|
"metadata": {
|
|
8
8
|
"description": "Official marketplace for hit-em-with-the-docs - Self-managing documentation system",
|
|
9
|
-
"version": "2.0.
|
|
9
|
+
"version": "2.0.2"
|
|
10
10
|
},
|
|
11
11
|
"plugins": [
|
|
12
12
|
{
|
|
13
13
|
"name": "hit-em-with-the-docs",
|
|
14
14
|
"description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
|
|
15
|
-
"version": "2.0.
|
|
15
|
+
"version": "2.0.2",
|
|
16
16
|
"author": {
|
|
17
17
|
"name": "TheGlitchKing"
|
|
18
18
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hit-em-with-the-docs",
|
|
3
3
|
"description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
|
|
4
|
-
"version": "2.0.
|
|
4
|
+
"version": "2.0.2",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "TheGlitchKing",
|
|
7
7
|
"email": "theglitchking@users.noreply.github.com"
|
package/README.md
CHANGED
|
@@ -38,6 +38,47 @@ The system includes automated tools that check your documentation for problems.
|
|
|
38
38
|
- **CLI Tool**: Full command-line interface for all operations
|
|
39
39
|
- **Search Functionality**: Quick search across all documentation
|
|
40
40
|
- **Claude Code Plugin**: Integrates with Claude Code so AI can read and help maintain your docs
|
|
41
|
+
- **Sister Plugin Companion**: When [`semantic-pages`](https://github.com/TheGlitchKing/semantic-pages) is also installed, a **read-only** MCP server is auto-wired over `./.documentation/` so Claude can semantically search your docs without risking accidental writes (hewtd stays the sole writer of the tree)
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Sister Plugin: semantic-pages
|
|
46
|
+
|
|
47
|
+
`hit-em-with-the-docs` is the canonical **writer** of `./.documentation/` — it scaffolds the 15-domain structure, classifies incoming docs, maintains the 22-field metadata schema, checks links, and produces health reports. By design, it treats `./.documentation/` as a tree it owns.
|
|
48
|
+
|
|
49
|
+
[`semantic-pages`](https://github.com/TheGlitchKing/semantic-pages) is the canonical **reader**. It's a local MCP server that indexes any folder of markdown into a vector database + knowledge graph, exposing semantic search, wikilink traversal, and CRUD tools to Claude Code.
|
|
50
|
+
|
|
51
|
+
When both plugins are installed together, `semantic-pages` auto-detects hewtd via Claude Code's plugin registry and stands up a **second, read-only** MCP instance pointed at `./.documentation/`. The read-only mode suppresses all 7 write tools (`create_note`, `update_note`, `delete_note`, `move_note`, `update_frontmatter`, `manage_tags`, `rename_tag`) so Claude can search and read the docs tree but can't race hewtd over writes. Your personal scratch vault at `./.claude/.vault/` stays fully read/write.
|
|
52
|
+
|
|
53
|
+
### Behavior matrix
|
|
54
|
+
|
|
55
|
+
| `hit-em-with-the-docs` | `semantic-pages` | Result |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| ✗ | ✗ | nothing |
|
|
58
|
+
| ✓ | ✗ | hewtd CLI only; `.documentation/` managed but not indexed |
|
|
59
|
+
| ✗ | ✓ | single MCP at `./.claude/.vault` (read/write) |
|
|
60
|
+
| ✓ | ✓ | `./.claude/.vault` (r/w) **+** `./.documentation` (read-only) |
|
|
61
|
+
|
|
62
|
+
### How it's wired
|
|
63
|
+
|
|
64
|
+
`semantic-pages` ships a `SessionStart` hook that runs at the start of every Claude Code session and reconciles the project's `.mcp.json`. If hewtd is enabled in `~/.claude/settings.json` **and** `./.documentation/` exists in the current project, it adds a `semantic-pages` MCP entry pointed at `./.documentation` with `--read-only`. If either condition stops being true, it idempotently cleans up. See the [semantic-pages Sister Plugin docs](https://github.com/TheGlitchKing/semantic-pages#sister-plugin-hit-em-with-the-docs) for the full auto-wiring behavior.
|
|
65
|
+
|
|
66
|
+
### Why we don't do it from hewtd's side
|
|
67
|
+
|
|
68
|
+
hewtd does **not** ship any MCP configuration, declare semantic-pages as a dependency, or write to `.mcp.json`. Installing hewtd alone gives you a CLI-only tool with no MCP server — your project stays clean. The auto-wire only kicks in when a user has explicitly installed both plugins, signaling they want Claude to semantically index the hewtd-managed tree. The wiring logic lives entirely on the semantic-pages side.
|
|
69
|
+
|
|
70
|
+
### Install both
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
# Inside a Claude Code session
|
|
74
|
+
/plugin marketplace add TheGlitchKing/hit-em-with-the-docs
|
|
75
|
+
/plugin install hit-em-with-the-docs@hit-em-with-the-docs-marketplace
|
|
76
|
+
|
|
77
|
+
/plugin marketplace add TheGlitchKing/semantic-pages
|
|
78
|
+
/plugin install semantic-pages@semantic-pages-marketplace
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Next session start, `./.claude/.vault/` is created, `.mcp.json` is wired, and Claude has 14 read tools on `./.documentation/` plus 21 full tools on `./.claude/.vault/`.
|
|
41
82
|
|
|
42
83
|
---
|
|
43
84
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@theglitchking/hit-em-with-the-docs",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/cli/index.js",
|