@afterxleep/doc-bot 1.7.3 → 1.7.5
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/README.md +10 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -79,12 +79,14 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
|
|
|
79
79
|
- AI doesn't know what documentation exists
|
|
80
80
|
- Users must know to ask specific questions
|
|
81
81
|
- No exploration or discovery capabilities
|
|
82
|
+
- AI agents rely on basic grep searches through codebases to infer project patterns
|
|
82
83
|
|
|
83
84
|
**MCP with doc-bot:**
|
|
84
85
|
- AI can list all available documentation
|
|
85
86
|
- Discovers relevant docs automatically
|
|
86
87
|
- Suggests documentation based on context
|
|
87
|
-
- Searchable knowledge base
|
|
88
|
+
- Searchable knowledge base with intelligent ranking
|
|
89
|
+
- No need for AI to grep through your codebase - dedicated search engine
|
|
88
90
|
|
|
89
91
|
## Installation
|
|
90
92
|
|
|
@@ -131,11 +133,11 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
|
|
|
131
133
|
|
|
132
134
|
## How to organize your documentation
|
|
133
135
|
|
|
134
|
-
Create a
|
|
136
|
+
Create a `doc-bot/` folder in your project root with markdown files using frontmatter:
|
|
135
137
|
|
|
136
138
|
```
|
|
137
139
|
your-project/
|
|
138
|
-
├──
|
|
140
|
+
├── doc-bot/
|
|
139
141
|
│ ├── coding-standards.md # Global rule (alwaysApply: true)
|
|
140
142
|
│ ├── security.md # Global rule (alwaysApply: true)
|
|
141
143
|
│ ├── testing.md # Contextual rule (alwaysApply: false)
|
|
@@ -144,7 +146,7 @@ your-project/
|
|
|
144
146
|
└── package.json
|
|
145
147
|
```
|
|
146
148
|
|
|
147
|
-
**Note:** The
|
|
149
|
+
**Note:** The `doc-bot` folder is the default location. You can use any folder name by specifying it with the `--docs` option.
|
|
148
150
|
|
|
149
151
|
### Documentation types:
|
|
150
152
|
|
|
@@ -153,7 +155,7 @@ your-project/
|
|
|
153
155
|
|
|
154
156
|
### Example documentation files:
|
|
155
157
|
|
|
156
|
-
**Global Rule Example** (
|
|
158
|
+
**Global Rule Example** (`doc-bot/coding-standards.md`):
|
|
157
159
|
```markdown
|
|
158
160
|
---
|
|
159
161
|
alwaysApply: true
|
|
@@ -171,7 +173,7 @@ keywords: ["code-quality", "standards", "best-practices"]
|
|
|
171
173
|
- Write descriptive variable names
|
|
172
174
|
```
|
|
173
175
|
|
|
174
|
-
**Contextual Rule Example** (
|
|
176
|
+
**Contextual Rule Example** (`doc-bot/testing.md`):
|
|
175
177
|
```markdown
|
|
176
178
|
---
|
|
177
179
|
alwaysApply: false
|
|
@@ -275,7 +277,7 @@ Ask your AI assistant something like "What documentation is available?" to test
|
|
|
275
277
|
doc-bot [options]
|
|
276
278
|
|
|
277
279
|
Options:
|
|
278
|
-
-d, --docs <path> Path to docs folder (default:
|
|
280
|
+
-d, --docs <path> Path to docs folder (default: doc-bot)
|
|
279
281
|
-c, --config <path> Path to manifest file (optional, for backward compatibility)
|
|
280
282
|
-v, --verbose Enable verbose logging
|
|
281
283
|
-w, --watch Watch for file changes
|
|
@@ -284,7 +286,7 @@ Options:
|
|
|
284
286
|
|
|
285
287
|
**Example usage:**
|
|
286
288
|
```bash
|
|
287
|
-
# Basic usage with default
|
|
289
|
+
# Basic usage with default doc-bot folder
|
|
288
290
|
doc-bot
|
|
289
291
|
|
|
290
292
|
# Specify a custom docs folder
|