omgkit 2.21.0 → 2.21.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/README.md +35 -1
- package/package.json +10 -3
- package/plugin/registry.yaml +1 -1
package/README.md
CHANGED
|
@@ -681,9 +681,41 @@ omgkit help # Show help
|
|
|
681
681
|
|
|
682
682
|
---
|
|
683
683
|
|
|
684
|
+
## Documentation Sync Automation
|
|
685
|
+
|
|
686
|
+
OMGKIT uses a **self-healing documentation system** that ensures docs are always synchronized with code:
|
|
687
|
+
|
|
688
|
+
### How It Works
|
|
689
|
+
|
|
690
|
+
1. **Code is Single Source of Truth**: All component metadata lives in plugin files
|
|
691
|
+
2. **Auto-Discovery**: Categories and counts are discovered dynamically, not hardcoded
|
|
692
|
+
3. **Auto-Generation**: mint.json navigation is generated from docs structure
|
|
693
|
+
4. **Validation Tests**: 23 tests verify docs-plugin sync before every release
|
|
694
|
+
|
|
695
|
+
### Documentation Commands
|
|
696
|
+
|
|
697
|
+
```bash
|
|
698
|
+
npm run docs:generate # Generate docs from plugin source
|
|
699
|
+
npm run docs:mint # Generate mint.json navigation
|
|
700
|
+
npm run docs:validate # Run docs sync validation tests
|
|
701
|
+
npm run docs:sync # Generate + validate (recommended)
|
|
702
|
+
```
|
|
703
|
+
|
|
704
|
+
### Pre-Release Protection
|
|
705
|
+
|
|
706
|
+
The `preversion` hook automatically runs `docs:sync` before version bumps:
|
|
707
|
+
|
|
708
|
+
```bash
|
|
709
|
+
npm version patch # Runs docs:sync automatically
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
If any sync issue is detected (missing pages, wrong counts, broken links), the version bump fails.
|
|
713
|
+
|
|
714
|
+
---
|
|
715
|
+
|
|
684
716
|
## Validation & Testing
|
|
685
717
|
|
|
686
|
-
OMGKIT has
|
|
718
|
+
OMGKIT has 5700+ automated tests ensuring system integrity.
|
|
687
719
|
|
|
688
720
|
### Run Tests
|
|
689
721
|
|
|
@@ -691,6 +723,7 @@ OMGKIT has 5600+ automated tests ensuring system integrity.
|
|
|
691
723
|
npm test # All tests
|
|
692
724
|
npm test -- tests/validation/ # Validation tests only
|
|
693
725
|
npm test -- tests/unit/ # Unit tests only
|
|
726
|
+
npm run test:docs # Documentation sync tests
|
|
694
727
|
```
|
|
695
728
|
|
|
696
729
|
### Test Categories
|
|
@@ -700,6 +733,7 @@ npm test -- tests/unit/ # Unit tests only
|
|
|
700
733
|
| Registry Sync | ~200 | Verify registry matches files |
|
|
701
734
|
| Alignment | ~400 | Component hierarchy validation |
|
|
702
735
|
| Documentation | ~500 | Quality and format checks |
|
|
736
|
+
| Docs Sync | 23 | Plugin-to-docs mapping validation |
|
|
703
737
|
| Format | ~300 | Naming convention compliance |
|
|
704
738
|
| Dependency Graph | ~600 | Reference integrity |
|
|
705
739
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "omgkit",
|
|
3
|
-
"version": "2.21.
|
|
4
|
-
"description": "Omega-Level Development Kit - AI Team System for Claude Code.
|
|
3
|
+
"version": "2.21.2",
|
|
4
|
+
"description": "Omega-Level Development Kit - AI Team System for Claude Code. 41 agents, 144 commands, 145 skills, 61 workflows.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"claude-code",
|
|
7
7
|
"ai",
|
|
@@ -43,10 +43,17 @@
|
|
|
43
43
|
"test:unit": "vitest run tests/unit",
|
|
44
44
|
"test:validation": "vitest run tests/validation",
|
|
45
45
|
"test:integration": "vitest run tests/integration",
|
|
46
|
+
"test:docs": "vitest run tests/validation/docs-sync.test.js",
|
|
46
47
|
"lint": "eslint .",
|
|
47
48
|
"docs:generate": "node scripts/generate-docs.js",
|
|
49
|
+
"docs:mint": "node scripts/generate-mint-json.js",
|
|
50
|
+
"docs:validate": "npm run test:docs",
|
|
51
|
+
"docs:sync": "npm run docs:generate && npm run docs:validate",
|
|
48
52
|
"docs:dev": "cd docs && mintlify dev",
|
|
49
|
-
"docs:build": "npm run docs:generate"
|
|
53
|
+
"docs:build": "npm run docs:generate",
|
|
54
|
+
"preversion": "npm run docs:sync && npm test",
|
|
55
|
+
"version": "node -e \"const fs=require('fs');const r=require('./plugin/registry.yaml','utf8');\" || true",
|
|
56
|
+
"postversion": "echo 'Version bumped. Run: git push && npm publish'"
|
|
50
57
|
},
|
|
51
58
|
"engines": {
|
|
52
59
|
"node": ">=18.0.0"
|