mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
The install directory is now configurable, with a few minute issues
This commit is contained in:
@@ -137,7 +137,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
|
||||
```bash
|
||||
# Load BMad Master or any agent
|
||||
bmad/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
{bmad_folder}/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
```
|
||||
|
||||
- Splits on level 2 sections by default
|
||||
@@ -147,7 +147,7 @@ If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
2. **Then:** Run `index-docs` task to create navigation:
|
||||
|
||||
```bash
|
||||
bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
|
||||
@@ -210,7 +210,7 @@ If you have **good, current documentation** but it's in massive files:
|
||||
|
||||
```bash
|
||||
# For each massive doc (>500 lines or 10+ level 2 sections)
|
||||
bmad/core/tools/shard-doc.xml \
|
||||
{bmad_folder}/core/tools/shard-doc.xml \
|
||||
--input docs/api-documentation.md \
|
||||
--output docs/api/ \
|
||||
--level 2 # Split on ## headers (default)
|
||||
@@ -219,7 +219,7 @@ bmad/core/tools/shard-doc.xml \
|
||||
**Step 2: Generate index**
|
||||
|
||||
```bash
|
||||
bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
{bmad_folder}/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
**Step 3: Validate**
|
||||
|
||||
Reference in New Issue
Block a user