Appearance
Maintainer Notes
This page is for people extending the plugin itself, not end users running the workflow.
Design rules
- Keep
SKILL.mdwrappers lean and put command behavior inreferences/source-commands/orreferences/local-commands/. - Put shared rules in references or scripts instead of duplicating them across
SKILL.mdfiles. - Preserve file-backed handoff contracts between phases.
- Treat the orchestrator as workflow control, not as a substitute for downstream phase skills.
Development workflow
- Edit the relevant
SKILL.md, script, or reference file. - Update
agents/openai.yamlif user-facing labels or invocation wording changed. - Refresh docs when visible behavior changed.
- Run
python3 plugins/specark/scripts/validate_plugin_bundle.py. - Run
npm run docs:buildbefore publishing docs changes.
Source of truth
Upstream command text lives under plugins/specark/references/source-commands/.
SpecArk-authored local command text lives under plugins/specark/references/local-commands/.
Both forms are authoritative for their wrappers. source-commands/ is reserved for copied upstream originals; local workflow contracts should use local-commands/ instead of embedding long behavior in SKILL.md.
Docs site
Local commands:
bash
npm install
npm run docs:dev
npm run docs:build
npm run docs:previewGitHub Pages setup (one-time):
- Open repository settings → Pages.
- Set
Build and deployment > SourcetoGitHub Actions. - Push to
mainand wait for the deploy workflow to finish.
Notes for further development
- Keep documentation split between user-facing operation and maintainer-facing release work.
- Expand skill docs when behavior changes, but avoid turning them into copies of command files.
- If you broaden test generation beyond API workflows, document the new scope clearly in both the README and the skill pages.