mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
docs: fix docs build (#1336)
* docs: fix docs build * docs: conditional pre-commit * fix: included more LLM exclude patterns * fix: iclude docs:build --------- Co-authored-by: Brian <bmadcode@gmail.com>
This commit is contained in:
21
.github/workflows/quality.yaml
vendored
21
.github/workflows/quality.yaml
vendored
@@ -69,6 +69,27 @@ jobs:
|
|||||||
- name: markdownlint
|
- name: markdownlint
|
||||||
run: npm run lint:md
|
run: npm run lint:md
|
||||||
|
|
||||||
|
docs:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: ".nvmrc"
|
||||||
|
cache: "npm"
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Validate documentation links
|
||||||
|
run: npm run docs:validate-links
|
||||||
|
|
||||||
|
- name: Build documentation
|
||||||
|
run: npm run docs:build
|
||||||
|
|
||||||
validate:
|
validate:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
@@ -5,3 +5,16 @@ npx --no-install lint-staged
|
|||||||
|
|
||||||
# Validate everything
|
# Validate everything
|
||||||
npm test
|
npm test
|
||||||
|
|
||||||
|
# Validate docs links only when docs change
|
||||||
|
if command -v rg >/dev/null 2>&1; then
|
||||||
|
if git diff --cached --name-only | rg -q '^docs/'; then
|
||||||
|
npm run docs:validate-links
|
||||||
|
npm run docs:build
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
if git diff --cached --name-only | grep -Eq '^docs/'; then
|
||||||
|
npm run docs:validate-links
|
||||||
|
npm run docs:build
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|||||||
@@ -250,7 +250,7 @@ Risk scores inform test priorities (but aren't the only factor):
|
|||||||
- **Test Levels:** E2E smoke test only
|
- **Test Levels:** E2E smoke test only
|
||||||
- **Example:** Theme customization, experimental features
|
- **Example:** Theme customization, experimental features
|
||||||
|
|
||||||
**Note:** Priorities consider risk scores plus business context (usage frequency, user impact, etc.). See [Test Priorities Matrix](/docs/reference/tea/knowledge-base.md#test-priorities-matrix) for complete criteria.
|
**Note:** Priorities consider risk scores plus business context (usage frequency, user impact, etc.). See [Test Priorities Matrix](/docs/reference/tea/knowledge-base.md#quality-standards) for complete criteria.
|
||||||
|
|
||||||
### 3. Mitigation Plans
|
### 3. Mitigation Plans
|
||||||
|
|
||||||
|
|||||||
@@ -866,8 +866,8 @@ test('should work with optional button', async ({ page }) => {
|
|||||||
## Technical Implementation
|
## Technical Implementation
|
||||||
|
|
||||||
For detailed test quality patterns, see:
|
For detailed test quality patterns, see:
|
||||||
- [Test Quality Fragment](/docs/reference/tea/knowledge-base.md#test-quality)
|
- [Test Quality Fragment](/docs/reference/tea/knowledge-base.md#quality-standards)
|
||||||
- [Test Levels Framework Fragment](/docs/reference/tea/knowledge-base.md#test-levels-framework)
|
- [Test Levels Framework Fragment](/docs/reference/tea/knowledge-base.md#quality-standards)
|
||||||
- [Complete Knowledge Base Index](/docs/reference/tea/knowledge-base.md)
|
- [Complete Knowledge Base Index](/docs/reference/tea/knowledge-base.md)
|
||||||
|
|
||||||
## Related Concepts
|
## Related Concepts
|
||||||
|
|||||||
@@ -27,7 +27,17 @@ const REPO_URL = 'https://github.com/bmad-code-org/BMAD-METHOD';
|
|||||||
const LLM_MAX_CHARS = 600_000;
|
const LLM_MAX_CHARS = 600_000;
|
||||||
const LLM_WARN_CHARS = 500_000;
|
const LLM_WARN_CHARS = 500_000;
|
||||||
|
|
||||||
const LLM_EXCLUDE_PATTERNS = ['changelog', 'ide-info/', 'v4-to-v6-upgrade', 'downloads/', 'faq'];
|
const LLM_EXCLUDE_PATTERNS = [
|
||||||
|
'changelog',
|
||||||
|
'ide-info/',
|
||||||
|
'v4-to-v6-upgrade',
|
||||||
|
'downloads/',
|
||||||
|
'faq',
|
||||||
|
'_STYLE_GUIDE.md',
|
||||||
|
'_archive/',
|
||||||
|
'reference/glossary/',
|
||||||
|
'explanation/game-dev/',
|
||||||
|
];
|
||||||
|
|
||||||
// =============================================================================
|
// =============================================================================
|
||||||
// Main Entry Point
|
// Main Entry Point
|
||||||
@@ -335,7 +345,6 @@ function runAstroBuild() {
|
|||||||
stdio: 'inherit',
|
stdio: 'inherit',
|
||||||
env: {
|
env: {
|
||||||
...process.env,
|
...process.env,
|
||||||
NODE_OPTIONS: `${process.env.NODE_OPTIONS || ''} --disable-warning=MODULE_TYPELESS_PACKAGE_JSON`.trim(),
|
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user