@afterxleep/doc-bot 1.7.4 → 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 +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -133,11 +133,11 @@ Traditional AI assistants use static rule files (like Cursor Rules or Copilot's
|
|
|
133
133
|
|
|
134
134
|
## How to organize your documentation
|
|
135
135
|
|
|
136
|
-
Create a
|
|
136
|
+
Create a `doc-bot/` folder in your project root with markdown files using frontmatter:
|
|
137
137
|
|
|
138
138
|
```
|
|
139
139
|
your-project/
|
|
140
|
-
├──
|
|
140
|
+
├── doc-bot/
|
|
141
141
|
│ ├── coding-standards.md # Global rule (alwaysApply: true)
|
|
142
142
|
│ ├── security.md # Global rule (alwaysApply: true)
|
|
143
143
|
│ ├── testing.md # Contextual rule (alwaysApply: false)
|
|
@@ -146,7 +146,7 @@ your-project/
|
|
|
146
146
|
└── package.json
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
**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.
|
|
150
150
|
|
|
151
151
|
### Documentation types:
|
|
152
152
|
|
|
@@ -155,7 +155,7 @@ your-project/
|
|
|
155
155
|
|
|
156
156
|
### Example documentation files:
|
|
157
157
|
|
|
158
|
-
**Global Rule Example** (
|
|
158
|
+
**Global Rule Example** (`doc-bot/coding-standards.md`):
|
|
159
159
|
```markdown
|
|
160
160
|
---
|
|
161
161
|
alwaysApply: true
|
|
@@ -173,7 +173,7 @@ keywords: ["code-quality", "standards", "best-practices"]
|
|
|
173
173
|
- Write descriptive variable names
|
|
174
174
|
```
|
|
175
175
|
|
|
176
|
-
**Contextual Rule Example** (
|
|
176
|
+
**Contextual Rule Example** (`doc-bot/testing.md`):
|
|
177
177
|
```markdown
|
|
178
178
|
---
|
|
179
179
|
alwaysApply: false
|
|
@@ -277,7 +277,7 @@ Ask your AI assistant something like "What documentation is available?" to test
|
|
|
277
277
|
doc-bot [options]
|
|
278
278
|
|
|
279
279
|
Options:
|
|
280
|
-
-d, --docs <path> Path to docs folder (default:
|
|
280
|
+
-d, --docs <path> Path to docs folder (default: doc-bot)
|
|
281
281
|
-c, --config <path> Path to manifest file (optional, for backward compatibility)
|
|
282
282
|
-v, --verbose Enable verbose logging
|
|
283
283
|
-w, --watch Watch for file changes
|
|
@@ -286,7 +286,7 @@ Options:
|
|
|
286
286
|
|
|
287
287
|
**Example usage:**
|
|
288
288
|
```bash
|
|
289
|
-
# Basic usage with default
|
|
289
|
+
# Basic usage with default doc-bot folder
|
|
290
290
|
doc-bot
|
|
291
291
|
|
|
292
292
|
# Specify a custom docs folder
|