@open-agent-toolkit/cli 0.0.10
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 +50 -0
- package/assets/agents/oat-codebase-mapper.md +275 -0
- package/assets/agents/oat-reviewer.md +350 -0
- package/assets/agents/skeptical-evaluator.md +126 -0
- package/assets/docs/contributing/code.md +95 -0
- package/assets/docs/contributing/commit-conventions.md +41 -0
- package/assets/docs/contributing/design-principles.md +124 -0
- package/assets/docs/contributing/documentation.md +69 -0
- package/assets/docs/contributing/hooks-and-safety.md +31 -0
- package/assets/docs/contributing/index.md +18 -0
- package/assets/docs/contributing/markdown-features.md +117 -0
- package/assets/docs/contributing/skills.md +68 -0
- package/assets/docs/guide/cli-reference.md +211 -0
- package/assets/docs/guide/concepts.md +88 -0
- package/assets/docs/guide/configuration.md +130 -0
- package/assets/docs/guide/documentation/commands.md +157 -0
- package/assets/docs/guide/documentation/index.md +27 -0
- package/assets/docs/guide/documentation/quickstart.md +164 -0
- package/assets/docs/guide/documentation/workflows.md +67 -0
- package/assets/docs/guide/getting-started.md +63 -0
- package/assets/docs/guide/ideas/index.md +34 -0
- package/assets/docs/guide/ideas/lifecycle.md +106 -0
- package/assets/docs/guide/index.md +20 -0
- package/assets/docs/guide/provider-sync/commands.md +100 -0
- package/assets/docs/guide/provider-sync/config.md +77 -0
- package/assets/docs/guide/provider-sync/index.md +65 -0
- package/assets/docs/guide/provider-sync/manifest-and-drift.md +55 -0
- package/assets/docs/guide/provider-sync/providers.md +67 -0
- package/assets/docs/guide/provider-sync/scope-and-surface.md +64 -0
- package/assets/docs/guide/skills/index.md +115 -0
- package/assets/docs/guide/tool-packs.md +167 -0
- package/assets/docs/guide/workflow/artifacts.md +44 -0
- package/assets/docs/guide/workflow/hill-checkpoints.md +53 -0
- package/assets/docs/guide/workflow/index.md +34 -0
- package/assets/docs/guide/workflow/lifecycle.md +207 -0
- package/assets/docs/guide/workflow/pr-flow.md +55 -0
- package/assets/docs/guide/workflow/repo-analysis.md +96 -0
- package/assets/docs/guide/workflow/reviews.md +98 -0
- package/assets/docs/guide/workflow/state-machine.md +74 -0
- package/assets/docs/index.md +45 -0
- package/assets/docs/quickstart.md +162 -0
- package/assets/docs/reference/docs-index-contract.md +53 -0
- package/assets/docs/reference/file-locations.md +109 -0
- package/assets/docs/reference/index.md +29 -0
- package/assets/docs/reference/oat-directory-structure.md +236 -0
- package/assets/docs/reference/troubleshooting.md +63 -0
- package/assets/public-package-versions.json +6 -0
- package/assets/scripts/resolve-tracking.sh +233 -0
- package/assets/skills/analyze/SKILL.md +358 -0
- package/assets/skills/compare/SKILL.md +276 -0
- package/assets/skills/create-agnostic-skill/SKILL.md +410 -0
- package/assets/skills/create-agnostic-skill/references/skill-template.md +195 -0
- package/assets/skills/deep-research/SKILL.md +350 -0
- package/assets/skills/deep-research/references/schema-analysis.md +93 -0
- package/assets/skills/deep-research/references/schema-architectural.md +75 -0
- package/assets/skills/deep-research/references/schema-base.md +70 -0
- package/assets/skills/deep-research/references/schema-comparative.md +72 -0
- package/assets/skills/deep-research/references/schema-conceptual.md +68 -0
- package/assets/skills/deep-research/references/schema-technical.md +64 -0
- package/assets/skills/oat-agent-instructions-analyze/SKILL.md +500 -0
- package/assets/skills/oat-agent-instructions-analyze/references/analysis-artifact-template.md +248 -0
- package/assets/skills/oat-agent-instructions-analyze/references/bundle-summary-template.md +31 -0
- package/assets/skills/oat-agent-instructions-analyze/references/directory-assessment-criteria.md +93 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/agent-instruction.md +575 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/cursor-rules-files.md +510 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/provider-reference.md +429 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/rules-files.md +594 -0
- package/assets/skills/oat-agent-instructions-analyze/references/file-type-discovery-checklist.md +273 -0
- package/assets/skills/oat-agent-instructions-analyze/references/quality-checklist.md +125 -0
- package/assets/skills/oat-agent-instructions-analyze/references/recommendation-pack-template.md +45 -0
- package/assets/skills/oat-agent-instructions-analyze/references/recommendations-manifest-template.yaml +27 -0
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-instruction-files.sh +120 -0
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-providers.sh +135 -0
- package/assets/skills/oat-agent-instructions-apply/SKILL.md +507 -0
- package/assets/skills/oat-agent-instructions-apply/references/apply-plan-template.md +80 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/agent-instruction.md +575 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/cursor-rules-files.md +510 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/provider-reference.md +429 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/rules-files.md +594 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/agents-md-root.md +85 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/agents-md-scoped.md +62 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/claude-rule.md +67 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/copilot-instruction.md +70 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/copilot-shim.md +35 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/cursor-rule.md +84 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/glob-scoped-rule.md +59 -0
- package/assets/skills/oat-docs/SKILL.md +214 -0
- package/assets/skills/oat-docs-analyze/SKILL.md +355 -0
- package/assets/skills/oat-docs-analyze/references/analysis-artifact-template.md +192 -0
- package/assets/skills/oat-docs-analyze/references/directory-assessment-criteria.md +46 -0
- package/assets/skills/oat-docs-analyze/references/quality-checklist.md +48 -0
- package/assets/skills/oat-docs-apply/SKILL.md +339 -0
- package/assets/skills/oat-docs-apply/references/apply-plan-template.md +69 -0
- package/assets/skills/oat-doctor/SKILL.md +293 -0
- package/assets/skills/oat-idea-ideate/SKILL.md +187 -0
- package/assets/skills/oat-idea-new/SKILL.md +152 -0
- package/assets/skills/oat-idea-scratchpad/SKILL.md +115 -0
- package/assets/skills/oat-idea-summarize/SKILL.md +172 -0
- package/assets/skills/oat-pjm-add-backlog-item/SKILL.md +155 -0
- package/assets/skills/oat-pjm-review-backlog/SKILL.md +171 -0
- package/assets/skills/oat-pjm-review-backlog/references/backlog-review-template.md +172 -0
- package/assets/skills/oat-pjm-update-repo-reference/SKILL.md +128 -0
- package/assets/skills/oat-project-capture/SKILL.md +306 -0
- package/assets/skills/oat-project-clear-active/SKILL.md +50 -0
- package/assets/skills/oat-project-complete/SKILL.md +461 -0
- package/assets/skills/oat-project-design/SKILL.md +461 -0
- package/assets/skills/oat-project-discover/SKILL.md +395 -0
- package/assets/skills/oat-project-document/SKILL.md +468 -0
- package/assets/skills/oat-project-implement/SKILL.md +736 -0
- package/assets/skills/oat-project-import-plan/SKILL.md +228 -0
- package/assets/skills/oat-project-import-plan/scripts/find-recent-provider-plans.sh +149 -0
- package/assets/skills/oat-project-new/SKILL.md +74 -0
- package/assets/skills/oat-project-next/SKILL.md +345 -0
- package/assets/skills/oat-project-open/SKILL.md +47 -0
- package/assets/skills/oat-project-plan/SKILL.md +415 -0
- package/assets/skills/oat-project-plan-writing/SKILL.md +116 -0
- package/assets/skills/oat-project-pr-final/SKILL.md +391 -0
- package/assets/skills/oat-project-pr-progress/SKILL.md +354 -0
- package/assets/skills/oat-project-progress/SKILL.md +342 -0
- package/assets/skills/oat-project-promote-spec-driven/SKILL.md +155 -0
- package/assets/skills/oat-project-quick-start/SKILL.md +363 -0
- package/assets/skills/oat-project-reconcile/SKILL.md +738 -0
- package/assets/skills/oat-project-review-provide/SKILL.md +728 -0
- package/assets/skills/oat-project-review-receive/SKILL.md +641 -0
- package/assets/skills/oat-project-review-receive-remote/SKILL.md +235 -0
- package/assets/skills/oat-project-revise/SKILL.md +316 -0
- package/assets/skills/oat-project-spec/SKILL.md +471 -0
- package/assets/skills/oat-project-subagent-implement/SKILL.md +549 -0
- package/assets/skills/oat-project-subagent-implement/examples/pattern-hill-checkpoint.md +110 -0
- package/assets/skills/oat-project-subagent-implement/examples/pattern-parallel-phases.md +118 -0
- package/assets/skills/oat-project-subagent-implement/scripts/dispatch.sh +133 -0
- package/assets/skills/oat-project-subagent-implement/scripts/reconcile.sh +182 -0
- package/assets/skills/oat-project-subagent-implement/scripts/review-gate.sh +187 -0
- package/assets/skills/oat-project-subagent-implement/tests/fixtures/sample-plan.md +234 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-dry-run.sh +126 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-hill-checkpoint.sh +127 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-reconcile.sh +254 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-review-gate.sh +220 -0
- package/assets/skills/oat-project-summary/SKILL.md +227 -0
- package/assets/skills/oat-repo-knowledge-index/SKILL.md +724 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/architecture.md +83 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/concerns.md +97 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/conventions.md +100 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/integrations.md +91 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/stack.md +86 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/structure.md +88 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/testing.md +137 -0
- package/assets/skills/oat-repo-maintainability-review/SKILL.md +198 -0
- package/assets/skills/oat-repo-maintainability-review/references/dx-checklist.md +33 -0
- package/assets/skills/oat-repo-maintainability-review/references/repo-review-artifact-template.md +72 -0
- package/assets/skills/oat-repo-maintainability-review/references/repo-review-rubric.md +66 -0
- package/assets/skills/oat-repo-maintainability-review/scripts/resolve-analysis-output.sh +162 -0
- package/assets/skills/oat-review-provide/SKILL.md +231 -0
- package/assets/skills/oat-review-provide/references/review-artifact-template.md +55 -0
- package/assets/skills/oat-review-provide/scripts/resolve-review-output.sh +124 -0
- package/assets/skills/oat-review-receive/SKILL.md +238 -0
- package/assets/skills/oat-review-receive-remote/SKILL.md +250 -0
- package/assets/skills/oat-worktree-bootstrap/SKILL.md +208 -0
- package/assets/skills/oat-worktree-bootstrap/references/worktree-conventions.md +58 -0
- package/assets/skills/oat-worktree-bootstrap-auto/SKILL.md +245 -0
- package/assets/skills/oat-worktree-bootstrap-auto/scripts/bootstrap.sh +194 -0
- package/assets/skills/skeptic/SKILL.md +261 -0
- package/assets/skills/synthesize/SKILL.md +361 -0
- package/assets/templates/backlog-item.md +24 -0
- package/assets/templates/design.md +315 -0
- package/assets/templates/discovery.md +135 -0
- package/assets/templates/docs-app-fuma/app/[[...slug]]/page.tsx +30 -0
- package/assets/templates/docs-app-fuma/app/api/search/route.ts +8 -0
- package/assets/templates/docs-app-fuma/app/globals.css +69 -0
- package/assets/templates/docs-app-fuma/app/layout.tsx +26 -0
- package/assets/templates/docs-app-fuma/docs/contributing.md +71 -0
- package/assets/templates/docs-app-fuma/docs/getting-started.md +40 -0
- package/assets/templates/docs-app-fuma/docs/index.md +13 -0
- package/assets/templates/docs-app-fuma/lib/source.ts +8 -0
- package/assets/templates/docs-app-fuma/next.config.js +6 -0
- package/assets/templates/docs-app-fuma/package.json.template +38 -0
- package/assets/templates/docs-app-fuma/postcss.config.mjs +7 -0
- package/assets/templates/docs-app-fuma/source.config.ts +14 -0
- package/assets/templates/docs-app-fuma/tsconfig.json +25 -0
- package/assets/templates/docs-app-mkdocs/docs/contributing.md +122 -0
- package/assets/templates/docs-app-mkdocs/docs/getting-started.md +28 -0
- package/assets/templates/docs-app-mkdocs/docs/index.md +8 -0
- package/assets/templates/docs-app-mkdocs/mkdocs.yml +47 -0
- package/assets/templates/docs-app-mkdocs/package.json.template +19 -0
- package/assets/templates/docs-app-mkdocs/requirements.txt +6 -0
- package/assets/templates/docs-app-mkdocs/setup-docs.sh +18 -0
- package/assets/templates/ideas/idea-discovery.md +39 -0
- package/assets/templates/ideas/idea-summary.md +42 -0
- package/assets/templates/ideas/ideas-backlog.md +21 -0
- package/assets/templates/ideas/ideas-scratchpad.md +10 -0
- package/assets/templates/implementation.md +207 -0
- package/assets/templates/plan.md +171 -0
- package/assets/templates/roadmap.md +24 -0
- package/assets/templates/spec.md +138 -0
- package/assets/templates/state.md +49 -0
- package/assets/templates/summary.md +82 -0
- package/dist/agents/canonical/index.d.ts +4 -0
- package/dist/agents/canonical/index.d.ts.map +1 -0
- package/dist/agents/canonical/index.js +2 -0
- package/dist/agents/canonical/parse.d.ts +4 -0
- package/dist/agents/canonical/parse.d.ts.map +1 -0
- package/dist/agents/canonical/parse.js +97 -0
- package/dist/agents/canonical/render.d.ts +3 -0
- package/dist/agents/canonical/render.d.ts.map +1 -0
- package/dist/agents/canonical/render.js +17 -0
- package/dist/agents/canonical/types.d.ts +22 -0
- package/dist/agents/canonical/types.d.ts.map +1 -0
- package/dist/agents/canonical/types.js +1 -0
- package/dist/app/command-context.d.ts +21 -0
- package/dist/app/command-context.d.ts.map +1 -0
- package/dist/app/command-context.js +18 -0
- package/dist/app/create-program.d.ts +3 -0
- package/dist/app/create-program.d.ts.map +1 -0
- package/dist/app/create-program.js +17 -0
- package/dist/commands/__tests__/helpers.d.ts +12 -0
- package/dist/commands/__tests__/helpers.d.ts.map +1 -0
- package/dist/commands/__tests__/helpers.js +36 -0
- package/dist/commands/backlog/index.d.ts +14 -0
- package/dist/commands/backlog/index.d.ts.map +1 -0
- package/dist/commands/backlog/index.js +80 -0
- package/dist/commands/backlog/init.d.ts +2 -0
- package/dist/commands/backlog/init.d.ts.map +1 -0
- package/dist/commands/backlog/init.js +66 -0
- package/dist/commands/backlog/regenerate-index.d.ts +2 -0
- package/dist/commands/backlog/regenerate-index.d.ts.map +1 -0
- package/dist/commands/backlog/regenerate-index.js +78 -0
- package/dist/commands/backlog/shared/generate-id.d.ts +4 -0
- package/dist/commands/backlog/shared/generate-id.d.ts.map +1 -0
- package/dist/commands/backlog/shared/generate-id.js +65 -0
- package/dist/commands/cleanup/artifacts/artifacts.d.ts +44 -0
- package/dist/commands/cleanup/artifacts/artifacts.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.js +381 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.d.ts +13 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.js +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.d.ts +14 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.js +74 -0
- package/dist/commands/cleanup/cleanup.types.d.ts +26 -0
- package/dist/commands/cleanup/cleanup.types.d.ts.map +1 -0
- package/dist/commands/cleanup/cleanup.types.js +1 -0
- package/dist/commands/cleanup/cleanup.utils.d.ts +17 -0
- package/dist/commands/cleanup/cleanup.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/cleanup.utils.js +44 -0
- package/dist/commands/cleanup/index.d.ts +3 -0
- package/dist/commands/cleanup/index.d.ts.map +1 -0
- package/dist/commands/cleanup/index.js +9 -0
- package/dist/commands/cleanup/project/project.d.ts +20 -0
- package/dist/commands/cleanup/project/project.d.ts.map +1 -0
- package/dist/commands/cleanup/project/project.js +263 -0
- package/dist/commands/cleanup/project/project.utils.d.ts +8 -0
- package/dist/commands/cleanup/project/project.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/project/project.utils.js +48 -0
- package/dist/commands/config/index.d.ts +16 -0
- package/dist/commands/config/index.d.ts.map +1 -0
- package/dist/commands/config/index.js +700 -0
- package/dist/commands/docs/analyze.d.ts +8 -0
- package/dist/commands/docs/analyze.d.ts.map +1 -0
- package/dist/commands/docs/analyze.js +45 -0
- package/dist/commands/docs/apply.d.ts +8 -0
- package/dist/commands/docs/apply.d.ts.map +1 -0
- package/dist/commands/docs/apply.js +45 -0
- package/dist/commands/docs/index-generate/generator.d.ts +9 -0
- package/dist/commands/docs/index-generate/generator.d.ts.map +1 -0
- package/dist/commands/docs/index-generate/generator.js +114 -0
- package/dist/commands/docs/index-generate/index.d.ts +16 -0
- package/dist/commands/docs/index-generate/index.d.ts.map +1 -0
- package/dist/commands/docs/index-generate/index.js +72 -0
- package/dist/commands/docs/index.d.ts +3 -0
- package/dist/commands/docs/index.d.ts.map +1 -0
- package/dist/commands/docs/index.js +17 -0
- package/dist/commands/docs/init/index.d.ts +18 -0
- package/dist/commands/docs/init/index.d.ts.map +1 -0
- package/dist/commands/docs/init/index.js +129 -0
- package/dist/commands/docs/init/resolve-options.d.ts +41 -0
- package/dist/commands/docs/init/resolve-options.d.ts.map +1 -0
- package/dist/commands/docs/init/resolve-options.js +120 -0
- package/dist/commands/docs/init/scaffold.d.ts +18 -0
- package/dist/commands/docs/init/scaffold.d.ts.map +1 -0
- package/dist/commands/docs/init/scaffold.js +233 -0
- package/dist/commands/docs/migrate/codemod.d.ts +6 -0
- package/dist/commands/docs/migrate/codemod.d.ts.map +1 -0
- package/dist/commands/docs/migrate/codemod.js +62 -0
- package/dist/commands/docs/migrate/frontmatter.d.ts +12 -0
- package/dist/commands/docs/migrate/frontmatter.d.ts.map +1 -0
- package/dist/commands/docs/migrate/frontmatter.js +55 -0
- package/dist/commands/docs/migrate/index.d.ts +18 -0
- package/dist/commands/docs/migrate/index.d.ts.map +1 -0
- package/dist/commands/docs/migrate/index.js +138 -0
- package/dist/commands/docs/nav/contents.d.ts +14 -0
- package/dist/commands/docs/nav/contents.d.ts.map +1 -0
- package/dist/commands/docs/nav/contents.js +106 -0
- package/dist/commands/docs/nav/index.d.ts +3 -0
- package/dist/commands/docs/nav/index.d.ts.map +1 -0
- package/dist/commands/docs/nav/index.js +7 -0
- package/dist/commands/docs/nav/sync.d.ts +20 -0
- package/dist/commands/docs/nav/sync.d.ts.map +1 -0
- package/dist/commands/docs/nav/sync.js +92 -0
- package/dist/commands/doctor/index.d.ts +32 -0
- package/dist/commands/doctor/index.d.ts.map +1 -0
- package/dist/commands/doctor/index.js +373 -0
- package/dist/commands/index-cmd/index.d.ts +11 -0
- package/dist/commands/index-cmd/index.d.ts.map +1 -0
- package/dist/commands/index-cmd/index.js +62 -0
- package/dist/commands/index-cmd/thin-index.d.ts +19 -0
- package/dist/commands/index-cmd/thin-index.d.ts.map +1 -0
- package/dist/commands/index-cmd/thin-index.js +330 -0
- package/dist/commands/index.d.ts +3 -0
- package/dist/commands/index.d.ts.map +1 -0
- package/dist/commands/index.js +38 -0
- package/dist/commands/init/detect-docs.d.ts +11 -0
- package/dist/commands/init/detect-docs.d.ts.map +1 -0
- package/dist/commands/init/detect-docs.js +51 -0
- package/dist/commands/init/gitignore.d.ts +6 -0
- package/dist/commands/init/gitignore.d.ts.map +1 -0
- package/dist/commands/init/gitignore.js +41 -0
- package/dist/commands/init/index.d.ts +70 -0
- package/dist/commands/init/index.d.ts.map +1 -0
- package/dist/commands/init/index.js +570 -0
- package/dist/commands/init/tools/core/index.d.ts +12 -0
- package/dist/commands/init/tools/core/index.d.ts.map +1 -0
- package/dist/commands/init/tools/core/index.js +67 -0
- package/dist/commands/init/tools/core/install-core.d.ts +30 -0
- package/dist/commands/init/tools/core/install-core.d.ts.map +1 -0
- package/dist/commands/init/tools/core/install-core.js +50 -0
- package/dist/commands/init/tools/docs/index.d.ts +17 -0
- package/dist/commands/init/tools/docs/index.d.ts.map +1 -0
- package/dist/commands/init/tools/docs/index.js +110 -0
- package/dist/commands/init/tools/docs/install-docs.d.ts +23 -0
- package/dist/commands/init/tools/docs/install-docs.d.ts.map +1 -0
- package/dist/commands/init/tools/docs/install-docs.js +58 -0
- package/dist/commands/init/tools/ideas/index.d.ts +16 -0
- package/dist/commands/init/tools/ideas/index.d.ts.map +1 -0
- package/dist/commands/init/tools/ideas/index.js +94 -0
- package/dist/commands/init/tools/ideas/install-ideas.d.ts +25 -0
- package/dist/commands/init/tools/ideas/install-ideas.d.ts.map +1 -0
- package/dist/commands/init/tools/ideas/install-ideas.js +78 -0
- package/dist/commands/init/tools/index.d.ts +51 -0
- package/dist/commands/init/tools/index.d.ts.map +1 -0
- package/dist/commands/init/tools/index.js +387 -0
- package/dist/commands/init/tools/project-management/index.d.ts +12 -0
- package/dist/commands/init/tools/project-management/index.d.ts.map +1 -0
- package/dist/commands/init/tools/project-management/index.js +61 -0
- package/dist/commands/init/tools/project-management/install-project-management.d.ts +22 -0
- package/dist/commands/init/tools/project-management/install-project-management.d.ts.map +1 -0
- package/dist/commands/init/tools/project-management/install-project-management.js +52 -0
- package/dist/commands/init/tools/research/index.d.ts +17 -0
- package/dist/commands/init/tools/research/index.d.ts.map +1 -0
- package/dist/commands/init/tools/research/index.js +110 -0
- package/dist/commands/init/tools/research/install-research.d.ts +23 -0
- package/dist/commands/init/tools/research/install-research.d.ts.map +1 -0
- package/dist/commands/init/tools/research/install-research.js +52 -0
- package/dist/commands/init/tools/shared/copy-helpers.d.ts +12 -0
- package/dist/commands/init/tools/shared/copy-helpers.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/copy-helpers.js +52 -0
- package/dist/commands/init/tools/shared/skill-manifest.d.ts +22 -0
- package/dist/commands/init/tools/shared/skill-manifest.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/skill-manifest.js +102 -0
- package/dist/commands/init/tools/shared/version.d.ts +3 -0
- package/dist/commands/init/tools/shared/version.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/version.js +27 -0
- package/dist/commands/init/tools/utility/index.d.ts +17 -0
- package/dist/commands/init/tools/utility/index.d.ts.map +1 -0
- package/dist/commands/init/tools/utility/index.js +109 -0
- package/dist/commands/init/tools/utility/install-utility.d.ts +20 -0
- package/dist/commands/init/tools/utility/install-utility.d.ts.map +1 -0
- package/dist/commands/init/tools/utility/install-utility.js +35 -0
- package/dist/commands/init/tools/workflows/index.d.ts +14 -0
- package/dist/commands/init/tools/workflows/index.d.ts.map +1 -0
- package/dist/commands/init/tools/workflows/index.js +84 -0
- package/dist/commands/init/tools/workflows/install-workflows.d.ts +32 -0
- package/dist/commands/init/tools/workflows/install-workflows.d.ts.map +1 -0
- package/dist/commands/init/tools/workflows/install-workflows.js +135 -0
- package/dist/commands/instructions/index.d.ts +3 -0
- package/dist/commands/instructions/index.d.ts.map +1 -0
- package/dist/commands/instructions/index.js +9 -0
- package/dist/commands/instructions/instructions.types.d.ts +52 -0
- package/dist/commands/instructions/instructions.types.d.ts.map +1 -0
- package/dist/commands/instructions/instructions.types.js +1 -0
- package/dist/commands/instructions/instructions.utils.d.ts +13 -0
- package/dist/commands/instructions/instructions.utils.d.ts.map +1 -0
- package/dist/commands/instructions/instructions.utils.js +211 -0
- package/dist/commands/instructions/sync/sync.d.ts +4 -0
- package/dist/commands/instructions/sync/sync.d.ts.map +1 -0
- package/dist/commands/instructions/sync/sync.js +142 -0
- package/dist/commands/instructions/validate/validate.d.ts +4 -0
- package/dist/commands/instructions/validate/validate.d.ts.map +1 -0
- package/dist/commands/instructions/validate/validate.js +53 -0
- package/dist/commands/internal/index.d.ts +3 -0
- package/dist/commands/internal/index.d.ts.map +1 -0
- package/dist/commands/internal/index.js +7 -0
- package/dist/commands/internal/validate-oat-skills.d.ts +10 -0
- package/dist/commands/internal/validate-oat-skills.d.ts.map +1 -0
- package/dist/commands/internal/validate-oat-skills.js +66 -0
- package/dist/commands/local/apply.d.ts +6 -0
- package/dist/commands/local/apply.d.ts.map +1 -0
- package/dist/commands/local/apply.js +56 -0
- package/dist/commands/local/expand.d.ts +8 -0
- package/dist/commands/local/expand.d.ts.map +1 -0
- package/dist/commands/local/expand.js +83 -0
- package/dist/commands/local/index.d.ts +3 -0
- package/dist/commands/local/index.d.ts.map +1 -0
- package/dist/commands/local/index.js +248 -0
- package/dist/commands/local/manage.d.ts +18 -0
- package/dist/commands/local/manage.d.ts.map +1 -0
- package/dist/commands/local/manage.js +66 -0
- package/dist/commands/local/status.d.ts +7 -0
- package/dist/commands/local/status.d.ts.map +1 -0
- package/dist/commands/local/status.js +46 -0
- package/dist/commands/local/sync.d.ts +20 -0
- package/dist/commands/local/sync.d.ts.map +1 -0
- package/dist/commands/local/sync.js +40 -0
- package/dist/commands/project/archive/archive-utils.d.ts +70 -0
- package/dist/commands/project/archive/archive-utils.d.ts.map +1 -0
- package/dist/commands/project/archive/archive-utils.js +236 -0
- package/dist/commands/project/archive/index.d.ts +20 -0
- package/dist/commands/project/archive/index.d.ts.map +1 -0
- package/dist/commands/project/archive/index.js +217 -0
- package/dist/commands/project/index.d.ts +3 -0
- package/dist/commands/project/index.d.ts.map +1 -0
- package/dist/commands/project/index.js +15 -0
- package/dist/commands/project/new/index.d.ts +17 -0
- package/dist/commands/project/new/index.d.ts.map +1 -0
- package/dist/commands/project/new/index.js +76 -0
- package/dist/commands/project/new/scaffold.d.ts +24 -0
- package/dist/commands/project/new/scaffold.d.ts.map +1 -0
- package/dist/commands/project/new/scaffold.js +177 -0
- package/dist/commands/project/open/index.d.ts +26 -0
- package/dist/commands/project/open/index.d.ts.map +1 -0
- package/dist/commands/project/open/index.js +139 -0
- package/dist/commands/project/pause/index.d.ts +27 -0
- package/dist/commands/project/pause/index.d.ts.map +1 -0
- package/dist/commands/project/pause/index.js +120 -0
- package/dist/commands/project/set-mode/index.d.ts +14 -0
- package/dist/commands/project/set-mode/index.d.ts.map +1 -0
- package/dist/commands/project/set-mode/index.js +115 -0
- package/dist/commands/providers/index.d.ts +4 -0
- package/dist/commands/providers/index.d.ts.map +1 -0
- package/dist/commands/providers/index.js +11 -0
- package/dist/commands/providers/inspect/inspect.d.ts +4 -0
- package/dist/commands/providers/inspect/inspect.d.ts.map +1 -0
- package/dist/commands/providers/inspect/inspect.js +156 -0
- package/dist/commands/providers/list/list.d.ts +4 -0
- package/dist/commands/providers/list/list.d.ts.map +1 -0
- package/dist/commands/providers/list/list.js +163 -0
- package/dist/commands/providers/providers.types.d.ts +63 -0
- package/dist/commands/providers/providers.types.d.ts.map +1 -0
- package/dist/commands/providers/providers.types.js +1 -0
- package/dist/commands/providers/set/index.d.ts +4 -0
- package/dist/commands/providers/set/index.d.ts.map +1 -0
- package/dist/commands/providers/set/index.js +138 -0
- package/dist/commands/remove/index.d.ts +3 -0
- package/dist/commands/remove/index.d.ts.map +1 -0
- package/dist/commands/remove/index.js +9 -0
- package/dist/commands/remove/skill/index.d.ts +2 -0
- package/dist/commands/remove/skill/index.d.ts.map +1 -0
- package/dist/commands/remove/skill/index.js +1 -0
- package/dist/commands/remove/skill/remove-skill.d.ts +23 -0
- package/dist/commands/remove/skill/remove-skill.d.ts.map +1 -0
- package/dist/commands/remove/skill/remove-skill.js +231 -0
- package/dist/commands/remove/skills/index.d.ts +2 -0
- package/dist/commands/remove/skills/index.d.ts.map +1 -0
- package/dist/commands/remove/skills/index.js +1 -0
- package/dist/commands/remove/skills/remove-skills.d.ts +14 -0
- package/dist/commands/remove/skills/remove-skills.d.ts.map +1 -0
- package/dist/commands/remove/skills/remove-skills.js +98 -0
- package/dist/commands/repo/index.d.ts +3 -0
- package/dist/commands/repo/index.d.ts.map +1 -0
- package/dist/commands/repo/index.js +7 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.d.ts +9 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.js +284 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.d.ts +3 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.js +56 -0
- package/dist/commands/repo/pr-comments/collect/index.d.ts +4 -0
- package/dist/commands/repo/pr-comments/collect/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/index.js +25 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.d.ts +62 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.js +1 -0
- package/dist/commands/repo/pr-comments/index.d.ts +3 -0
- package/dist/commands/repo/pr-comments/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/index.js +9 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.d.ts +4 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.js +21 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.d.ts +13 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.js +81 -0
- package/dist/commands/shared/adopt-stray.d.ts +22 -0
- package/dist/commands/shared/adopt-stray.d.ts.map +1 -0
- package/dist/commands/shared/adopt-stray.js +135 -0
- package/dist/commands/shared/agents-md.d.ts +18 -0
- package/dist/commands/shared/agents-md.d.ts.map +1 -0
- package/dist/commands/shared/agents-md.js +81 -0
- package/dist/commands/shared/codex-strays.d.ts +16 -0
- package/dist/commands/shared/codex-strays.d.ts.map +1 -0
- package/dist/commands/shared/codex-strays.js +116 -0
- package/dist/commands/shared/frontmatter-write.d.ts +8 -0
- package/dist/commands/shared/frontmatter-write.d.ts.map +1 -0
- package/dist/commands/shared/frontmatter-write.js +27 -0
- package/dist/commands/shared/frontmatter.d.ts +6 -0
- package/dist/commands/shared/frontmatter.d.ts.map +1 -0
- package/dist/commands/shared/frontmatter.js +35 -0
- package/dist/commands/shared/messages.d.ts +2 -0
- package/dist/commands/shared/messages.d.ts.map +1 -0
- package/dist/commands/shared/messages.js +1 -0
- package/dist/commands/shared/oat-paths.d.ts +2 -0
- package/dist/commands/shared/oat-paths.d.ts.map +1 -0
- package/dist/commands/shared/oat-paths.js +13 -0
- package/dist/commands/shared/shared.prompts.d.ts +21 -0
- package/dist/commands/shared/shared.prompts.d.ts.map +1 -0
- package/dist/commands/shared/shared.prompts.js +107 -0
- package/dist/commands/shared/shared.utils.d.ts +6 -0
- package/dist/commands/shared/shared.utils.d.ts.map +1 -0
- package/dist/commands/shared/shared.utils.js +9 -0
- package/dist/commands/state/generate.d.ts +21 -0
- package/dist/commands/state/generate.d.ts.map +1 -0
- package/dist/commands/state/generate.js +440 -0
- package/dist/commands/state/index.d.ts +11 -0
- package/dist/commands/state/index.d.ts.map +1 -0
- package/dist/commands/state/index.js +58 -0
- package/dist/commands/status/index.d.ts +44 -0
- package/dist/commands/status/index.d.ts.map +1 -0
- package/dist/commands/status/index.js +340 -0
- package/dist/commands/sync/apply.d.ts +4 -0
- package/dist/commands/sync/apply.d.ts.map +1 -0
- package/dist/commands/sync/apply.js +100 -0
- package/dist/commands/sync/dry-run.d.ts +4 -0
- package/dist/commands/sync/dry-run.d.ts.map +1 -0
- package/dist/commands/sync/dry-run.js +74 -0
- package/dist/commands/sync/index.d.ts +4 -0
- package/dist/commands/sync/index.d.ts.map +1 -0
- package/dist/commands/sync/index.js +225 -0
- package/dist/commands/sync/sync.types.d.ts +80 -0
- package/dist/commands/sync/sync.types.d.ts.map +1 -0
- package/dist/commands/sync/sync.types.js +1 -0
- package/dist/commands/sync/sync.utils.d.ts +3 -0
- package/dist/commands/sync/sync.utils.d.ts.map +1 -0
- package/dist/commands/sync/sync.utils.js +8 -0
- package/dist/commands/tools/index.d.ts +3 -0
- package/dist/commands/tools/index.d.ts.map +1 -0
- package/dist/commands/tools/index.js +17 -0
- package/dist/commands/tools/info/index.d.ts +4 -0
- package/dist/commands/tools/info/index.d.ts.map +1 -0
- package/dist/commands/tools/info/index.js +74 -0
- package/dist/commands/tools/info/info-tool.d.ts +21 -0
- package/dist/commands/tools/info/info-tool.d.ts.map +1 -0
- package/dist/commands/tools/info/info-tool.js +52 -0
- package/dist/commands/tools/install/index.d.ts +4 -0
- package/dist/commands/tools/install/index.d.ts.map +1 -0
- package/dist/commands/tools/install/index.js +34 -0
- package/dist/commands/tools/list/index.d.ts +4 -0
- package/dist/commands/tools/list/index.d.ts.map +1 -0
- package/dist/commands/tools/list/index.js +25 -0
- package/dist/commands/tools/list/list-tools.d.ts +13 -0
- package/dist/commands/tools/list/list-tools.d.ts.map +1 -0
- package/dist/commands/tools/list/list-tools.js +43 -0
- package/dist/commands/tools/outdated/index.d.ts +4 -0
- package/dist/commands/tools/outdated/index.d.ts.map +1 -0
- package/dist/commands/tools/outdated/index.js +25 -0
- package/dist/commands/tools/outdated/outdated-tools.d.ts +13 -0
- package/dist/commands/tools/outdated/outdated-tools.d.ts.map +1 -0
- package/dist/commands/tools/outdated/outdated-tools.js +43 -0
- package/dist/commands/tools/remove/index.d.ts +5 -0
- package/dist/commands/tools/remove/index.d.ts.map +1 -0
- package/dist/commands/tools/remove/index.js +122 -0
- package/dist/commands/tools/remove/remove-tools.d.ts +31 -0
- package/dist/commands/tools/remove/remove-tools.d.ts.map +1 -0
- package/dist/commands/tools/remove/remove-tools.js +41 -0
- package/dist/commands/tools/shared/auto-sync.d.ts +16 -0
- package/dist/commands/tools/shared/auto-sync.d.ts.map +1 -0
- package/dist/commands/tools/shared/auto-sync.js +17 -0
- package/dist/commands/tools/shared/scan-tools.d.ts +18 -0
- package/dist/commands/tools/shared/scan-tools.d.ts.map +1 -0
- package/dist/commands/tools/shared/scan-tools.js +128 -0
- package/dist/commands/tools/shared/types.d.ts +12 -0
- package/dist/commands/tools/shared/types.d.ts.map +1 -0
- package/dist/commands/tools/shared/types.js +1 -0
- package/dist/commands/tools/update/index.d.ts +8 -0
- package/dist/commands/tools/update/index.d.ts.map +1 -0
- package/dist/commands/tools/update/index.js +149 -0
- package/dist/commands/tools/update/update-tools.d.ts +29 -0
- package/dist/commands/tools/update/update-tools.d.ts.map +1 -0
- package/dist/commands/tools/update/update-tools.js +148 -0
- package/dist/config/index.d.ts +4 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +2 -0
- package/dist/config/oat-config.d.ts +61 -0
- package/dist/config/oat-config.d.ts.map +1 -0
- package/dist/config/oat-config.js +319 -0
- package/dist/config/runtime.d.ts +2 -0
- package/dist/config/runtime.d.ts.map +1 -0
- package/dist/config/runtime.js +3 -0
- package/dist/config/sync-config.d.ts +49 -0
- package/dist/config/sync-config.d.ts.map +1 -0
- package/dist/config/sync-config.js +94 -0
- package/dist/drift/detector.d.ts +4 -0
- package/dist/drift/detector.d.ts.map +1 -0
- package/dist/drift/detector.js +69 -0
- package/dist/drift/drift.types.d.ts +17 -0
- package/dist/drift/drift.types.d.ts.map +1 -0
- package/dist/drift/drift.types.js +1 -0
- package/dist/drift/index.d.ts +4 -0
- package/dist/drift/index.d.ts.map +1 -0
- package/dist/drift/index.js +2 -0
- package/dist/drift/strays.d.ts +7 -0
- package/dist/drift/strays.d.ts.map +1 -0
- package/dist/drift/strays.js +153 -0
- package/dist/engine/compute-plan.d.ts +16 -0
- package/dist/engine/compute-plan.d.ts.map +1 -0
- package/dist/engine/compute-plan.js +234 -0
- package/dist/engine/engine.types.d.ts +28 -0
- package/dist/engine/engine.types.d.ts.map +1 -0
- package/dist/engine/engine.types.js +8 -0
- package/dist/engine/execute-plan.d.ts +5 -0
- package/dist/engine/execute-plan.d.ts.map +1 -0
- package/dist/engine/execute-plan.js +141 -0
- package/dist/engine/hook.d.ts +23 -0
- package/dist/engine/hook.d.ts.map +1 -0
- package/dist/engine/hook.js +254 -0
- package/dist/engine/index.d.ts +9 -0
- package/dist/engine/index.d.ts.map +1 -0
- package/dist/engine/index.js +6 -0
- package/dist/engine/markers.d.ts +6 -0
- package/dist/engine/markers.d.ts.map +1 -0
- package/dist/engine/markers.js +24 -0
- package/dist/engine/scanner.d.ts +11 -0
- package/dist/engine/scanner.d.ts.map +1 -0
- package/dist/engine/scanner.js +65 -0
- package/dist/engine/test-helpers.d.ts +3 -0
- package/dist/engine/test-helpers.d.ts.map +1 -0
- package/dist/engine/test-helpers.js +31 -0
- package/dist/errors/cli-error.d.ts +5 -0
- package/dist/errors/cli-error.d.ts.map +1 -0
- package/dist/errors/cli-error.js +8 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +1 -0
- package/dist/fs/assets.d.ts +2 -0
- package/dist/fs/assets.d.ts.map +1 -0
- package/dist/fs/assets.js +22 -0
- package/dist/fs/index.d.ts +4 -0
- package/dist/fs/index.d.ts.map +1 -0
- package/dist/fs/index.js +3 -0
- package/dist/fs/io.d.ts +9 -0
- package/dist/fs/io.d.ts.map +1 -0
- package/dist/fs/io.js +74 -0
- package/dist/fs/paths.d.ts +9 -0
- package/dist/fs/paths.d.ts.map +1 -0
- package/dist/fs/paths.js +42 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +48 -0
- package/dist/manifest/hash.d.ts +5 -0
- package/dist/manifest/hash.d.ts.map +1 -0
- package/dist/manifest/hash.js +75 -0
- package/dist/manifest/index.d.ts +5 -0
- package/dist/manifest/index.d.ts.map +1 -0
- package/dist/manifest/index.js +3 -0
- package/dist/manifest/manager.d.ts +8 -0
- package/dist/manifest/manager.d.ts.map +1 -0
- package/dist/manifest/manager.js +86 -0
- package/dist/manifest/manifest.types.d.ts +157 -0
- package/dist/manifest/manifest.types.d.ts.map +1 -0
- package/dist/manifest/manifest.types.js +56 -0
- package/dist/providers/claude/adapter.d.ts +3 -0
- package/dist/providers/claude/adapter.d.ts.map +1 -0
- package/dist/providers/claude/adapter.js +20 -0
- package/dist/providers/claude/index.d.ts +3 -0
- package/dist/providers/claude/index.d.ts.map +1 -0
- package/dist/providers/claude/index.js +2 -0
- package/dist/providers/claude/paths.d.ts +4 -0
- package/dist/providers/claude/paths.d.ts.map +1 -0
- package/dist/providers/claude/paths.js +38 -0
- package/dist/providers/claude/rule-transform.d.ts +3 -0
- package/dist/providers/claude/rule-transform.d.ts.map +1 -0
- package/dist/providers/claude/rule-transform.js +22 -0
- package/dist/providers/codex/adapter.d.ts +3 -0
- package/dist/providers/codex/adapter.d.ts.map +1 -0
- package/dist/providers/codex/adapter.js +20 -0
- package/dist/providers/codex/codec/config-merge.d.ts +17 -0
- package/dist/providers/codex/codec/config-merge.d.ts.map +1 -0
- package/dist/providers/codex/codec/config-merge.js +61 -0
- package/dist/providers/codex/codec/export-to-codex.d.ts +9 -0
- package/dist/providers/codex/codec/export-to-codex.d.ts.map +1 -0
- package/dist/providers/codex/codec/export-to-codex.js +45 -0
- package/dist/providers/codex/codec/import-from-codex.d.ts +9 -0
- package/dist/providers/codex/codec/import-from-codex.d.ts.map +1 -0
- package/dist/providers/codex/codec/import-from-codex.js +52 -0
- package/dist/providers/codex/codec/shared.d.ts +7 -0
- package/dist/providers/codex/codec/shared.d.ts.map +1 -0
- package/dist/providers/codex/codec/shared.js +21 -0
- package/dist/providers/codex/codec/sync-extension.d.ts +32 -0
- package/dist/providers/codex/codec/sync-extension.d.ts.map +1 -0
- package/dist/providers/codex/codec/sync-extension.js +227 -0
- package/dist/providers/codex/index.d.ts +6 -0
- package/dist/providers/codex/index.d.ts.map +1 -0
- package/dist/providers/codex/index.js +5 -0
- package/dist/providers/codex/paths.d.ts +4 -0
- package/dist/providers/codex/paths.d.ts.map +1 -0
- package/dist/providers/codex/paths.js +28 -0
- package/dist/providers/copilot/adapter.d.ts +3 -0
- package/dist/providers/copilot/adapter.d.ts.map +1 -0
- package/dist/providers/copilot/adapter.js +30 -0
- package/dist/providers/copilot/index.d.ts +3 -0
- package/dist/providers/copilot/index.d.ts.map +1 -0
- package/dist/providers/copilot/index.js +2 -0
- package/dist/providers/copilot/paths.d.ts +4 -0
- package/dist/providers/copilot/paths.d.ts.map +1 -0
- package/dist/providers/copilot/paths.js +38 -0
- package/dist/providers/copilot/rule-transform.d.ts +3 -0
- package/dist/providers/copilot/rule-transform.d.ts.map +1 -0
- package/dist/providers/copilot/rule-transform.js +58 -0
- package/dist/providers/cursor/adapter.d.ts +3 -0
- package/dist/providers/cursor/adapter.d.ts.map +1 -0
- package/dist/providers/cursor/adapter.js +20 -0
- package/dist/providers/cursor/index.d.ts +3 -0
- package/dist/providers/cursor/index.d.ts.map +1 -0
- package/dist/providers/cursor/index.js +2 -0
- package/dist/providers/cursor/paths.d.ts +4 -0
- package/dist/providers/cursor/paths.d.ts.map +1 -0
- package/dist/providers/cursor/paths.js +38 -0
- package/dist/providers/cursor/rule-transform.d.ts +3 -0
- package/dist/providers/cursor/rule-transform.d.ts.map +1 -0
- package/dist/providers/cursor/rule-transform.js +48 -0
- package/dist/providers/gemini/adapter.d.ts +3 -0
- package/dist/providers/gemini/adapter.d.ts.map +1 -0
- package/dist/providers/gemini/adapter.js +20 -0
- package/dist/providers/gemini/index.d.ts +3 -0
- package/dist/providers/gemini/index.d.ts.map +1 -0
- package/dist/providers/gemini/index.js +2 -0
- package/dist/providers/gemini/paths.d.ts +4 -0
- package/dist/providers/gemini/paths.d.ts.map +1 -0
- package/dist/providers/gemini/paths.js +28 -0
- package/dist/providers/shared/adapter.types.d.ts +21 -0
- package/dist/providers/shared/adapter.types.d.ts.map +1 -0
- package/dist/providers/shared/adapter.types.js +1 -0
- package/dist/providers/shared/adapter.utils.d.ts +12 -0
- package/dist/providers/shared/adapter.utils.d.ts.map +1 -0
- package/dist/providers/shared/adapter.utils.js +57 -0
- package/dist/providers/shared/agent-codec.types.d.ts +13 -0
- package/dist/providers/shared/agent-codec.types.d.ts.map +1 -0
- package/dist/providers/shared/agent-codec.types.js +1 -0
- package/dist/providers/shared/index.d.ts +6 -0
- package/dist/providers/shared/index.d.ts.map +1 -0
- package/dist/providers/shared/index.js +2 -0
- package/dist/providers/shared/markdown-agent-codec.d.ts +5 -0
- package/dist/providers/shared/markdown-agent-codec.d.ts.map +1 -0
- package/dist/providers/shared/markdown-agent-codec.js +12 -0
- package/dist/release/public-package-contract.d.ts +14 -0
- package/dist/release/public-package-contract.d.ts.map +1 -0
- package/dist/release/public-package-contract.js +97 -0
- package/dist/rules/canonical/index.d.ts +6 -0
- package/dist/rules/canonical/index.d.ts.map +1 -0
- package/dist/rules/canonical/index.js +4 -0
- package/dist/rules/canonical/parse.d.ts +9 -0
- package/dist/rules/canonical/parse.d.ts.map +1 -0
- package/dist/rules/canonical/parse.js +103 -0
- package/dist/rules/canonical/provider-filenames.d.ts +3 -0
- package/dist/rules/canonical/provider-filenames.d.ts.map +1 -0
- package/dist/rules/canonical/provider-filenames.js +13 -0
- package/dist/rules/canonical/render.d.ts +5 -0
- package/dist/rules/canonical/render.d.ts.map +1 -0
- package/dist/rules/canonical/render.js +32 -0
- package/dist/rules/canonical/types.d.ts +16 -0
- package/dist/rules/canonical/types.d.ts.map +1 -0
- package/dist/rules/canonical/types.js +6 -0
- package/dist/shared/index.d.ts +3 -0
- package/dist/shared/index.d.ts.map +1 -0
- package/dist/shared/index.js +1 -0
- package/dist/shared/types.d.ts +10 -0
- package/dist/shared/types.d.ts.map +1 -0
- package/dist/shared/types.js +14 -0
- package/dist/ui/ansi.d.ts +2 -0
- package/dist/ui/ansi.d.ts.map +1 -0
- package/dist/ui/ansi.js +19 -0
- package/dist/ui/index.d.ts +7 -0
- package/dist/ui/index.d.ts.map +1 -0
- package/dist/ui/index.js +3 -0
- package/dist/ui/logger.d.ts +15 -0
- package/dist/ui/logger.d.ts.map +1 -0
- package/dist/ui/logger.js +52 -0
- package/dist/ui/output.d.ts +16 -0
- package/dist/ui/output.d.ts.map +1 -0
- package/dist/ui/output.js +135 -0
- package/dist/ui/spinner.d.ts +16 -0
- package/dist/ui/spinner.d.ts.map +1 -0
- package/dist/ui/spinner.js +46 -0
- package/dist/validation/index.d.ts +3 -0
- package/dist/validation/index.d.ts.map +1 -0
- package/dist/validation/index.js +1 -0
- package/dist/validation/skills.d.ts +10 -0
- package/dist/validation/skills.d.ts.map +1 -0
- package/dist/validation/skills.js +166 -0
- package/package.json +62 -0
|
@@ -0,0 +1,355 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: oat-docs-analyze
|
|
3
|
+
version: 1.2.0
|
|
4
|
+
description: Run when you need to evaluate documentation structure, navigation, and coverage against the OAT docs app contract. Produces a severity-rated analysis artifact for oat-docs-apply.
|
|
5
|
+
disable-model-invocation: true
|
|
6
|
+
user-invocable: true
|
|
7
|
+
allowed-tools: Read, Write, Bash(git:*), Glob, Grep, AskUserQuestion
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Docs Analysis
|
|
11
|
+
|
|
12
|
+
Scan a repository's documentation surface, evaluate it against the OAT docs contract, and write an actionable analysis artifact.
|
|
13
|
+
|
|
14
|
+
## Prerequisites
|
|
15
|
+
|
|
16
|
+
- Git repository with either an MkDocs app, a `docs/` tree, or root-level Markdown docs.
|
|
17
|
+
- `jq` available in PATH for tracking updates.
|
|
18
|
+
|
|
19
|
+
## Mode Assertion
|
|
20
|
+
|
|
21
|
+
**OAT MODE: Docs Analysis**
|
|
22
|
+
|
|
23
|
+
**Purpose:** Evaluate documentation quality, coverage, navigation, and `index.md` contract conformance.
|
|
24
|
+
|
|
25
|
+
**BLOCKED Activities:**
|
|
26
|
+
|
|
27
|
+
- No editing documentation files.
|
|
28
|
+
- No scaffolding new docs apps.
|
|
29
|
+
- No modifying `mkdocs.yml` or navigation.
|
|
30
|
+
|
|
31
|
+
**ALLOWED Activities:**
|
|
32
|
+
|
|
33
|
+
- Reading docs trees, MkDocs config, and related repository metadata.
|
|
34
|
+
- Writing a docs analysis artifact to `.oat/repo/analysis/`.
|
|
35
|
+
- Updating docs analysis tracking metadata.
|
|
36
|
+
|
|
37
|
+
## Analyze vs Apply Boundary
|
|
38
|
+
|
|
39
|
+
`oat-docs-analyze` owns discovery, evaluation, evidence gathering, and recommendation shaping.
|
|
40
|
+
The analysis artifact must be detailed enough that `oat-docs-apply` can execute approved
|
|
41
|
+
recommendations without rediscovering docs conventions from scratch.
|
|
42
|
+
|
|
43
|
+
`oat-docs-apply` may verify that cited files still exist and may read those same cited
|
|
44
|
+
sources while generating output, but it must not invent unsupported docs conventions,
|
|
45
|
+
create new recommendations, or fill in missing evidence gaps on its own.
|
|
46
|
+
|
|
47
|
+
**Self-Correction Protocol:**
|
|
48
|
+
If you catch yourself:
|
|
49
|
+
|
|
50
|
+
- Editing docs content directly -> STOP and move that recommendation to the artifact.
|
|
51
|
+
- Rewriting navigation while analyzing -> STOP and record the required fix instead.
|
|
52
|
+
|
|
53
|
+
**Recovery:**
|
|
54
|
+
|
|
55
|
+
1. Return to read-only analysis.
|
|
56
|
+
2. Capture the needed change as a finding or recommendation.
|
|
57
|
+
|
|
58
|
+
## Progress Indicators (User-Facing)
|
|
59
|
+
|
|
60
|
+
When executing this skill, provide lightweight progress feedback so the user can tell what’s happening.
|
|
61
|
+
|
|
62
|
+
- Print a phase banner once at start:
|
|
63
|
+
|
|
64
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
65
|
+
OAT ▸ DOCS ANALYSIS
|
|
66
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
67
|
+
|
|
68
|
+
- Use step indicators:
|
|
69
|
+
- `[1/9] Resolving docs target + mode…`
|
|
70
|
+
- `[2/9] Inventorying docs files…`
|
|
71
|
+
- `[3/9] Evaluating index contract…`
|
|
72
|
+
- `[4/9] Assessing quality + coverage…`
|
|
73
|
+
- `[5/9] Verifying substantive claims…`
|
|
74
|
+
- `[6/9] Finding content opportunities…`
|
|
75
|
+
- `[7/9] Checking nav and drift…`
|
|
76
|
+
- `[8/9] Writing analysis artifact…`
|
|
77
|
+
- `[9/9] Updating tracking + summary…`
|
|
78
|
+
|
|
79
|
+
## Process
|
|
80
|
+
|
|
81
|
+
### Step 0: Resolve Docs Target and Analysis Mode
|
|
82
|
+
|
|
83
|
+
Determine the documentation root using the first matching surface:
|
|
84
|
+
|
|
85
|
+
1. `apps/*/mkdocs.yml`
|
|
86
|
+
2. `mkdocs.yml` at repo root
|
|
87
|
+
3. `docs/`
|
|
88
|
+
4. Root-level Markdown docs (`README.md`, `CONTRIBUTING.md`, etc.) when no docs app exists
|
|
89
|
+
|
|
90
|
+
Prefer the OAT docs app when multiple MkDocs apps exist and one is clearly the active repo docs surface.
|
|
91
|
+
|
|
92
|
+
Resolve tracking and analysis mode using the shared helper:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
TRACKING_SCRIPT=".oat/scripts/resolve-tracking.sh"
|
|
96
|
+
TRACKING=$(bash "$TRACKING_SCRIPT" read docs 2>/dev/null || true)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
- If the stored commit exists, run in `delta` mode and scope drift checks to changed docs directories.
|
|
100
|
+
- Otherwise run in `full` mode.
|
|
101
|
+
|
|
102
|
+
### Step 1: Inventory the Docs Surface
|
|
103
|
+
|
|
104
|
+
Build a complete inventory of:
|
|
105
|
+
|
|
106
|
+
- All Markdown files in the docs surface
|
|
107
|
+
- All directories containing Markdown files
|
|
108
|
+
- All `index.md` files
|
|
109
|
+
- Any `overview.md` files
|
|
110
|
+
- `mkdocs.yml` nav entries when present
|
|
111
|
+
|
|
112
|
+
Record the docs surface type:
|
|
113
|
+
|
|
114
|
+
- `mkdocs-app`
|
|
115
|
+
- `docs-tree`
|
|
116
|
+
- `root-markdown`
|
|
117
|
+
|
|
118
|
+
Capture the evidence sources that will justify later findings and recommendations. Prefer:
|
|
119
|
+
|
|
120
|
+
- `mkdocs.yml` and generated nav structure
|
|
121
|
+
- `docs/contributing.md`, contributor guides, and setup docs
|
|
122
|
+
- `package.json` scripts, `requirements.txt`, and docs bootstrap scripts
|
|
123
|
+
- existing `index.md` trees and repeated directory patterns
|
|
124
|
+
- exact missing or stale paths, commands, and page references
|
|
125
|
+
|
|
126
|
+
Do **not** infer docs structure conventions from a tiny sample of pages when the broader
|
|
127
|
+
tree or config disagrees.
|
|
128
|
+
|
|
129
|
+
### Step 2: Evaluate the `index.md` Contract
|
|
130
|
+
|
|
131
|
+
Use `references/quality-checklist.md` and `references/directory-assessment-criteria.md`.
|
|
132
|
+
|
|
133
|
+
For every documentation directory:
|
|
134
|
+
|
|
135
|
+
1. Verify `index.md` exists.
|
|
136
|
+
2. Verify `index.md` includes a `## Contents` section.
|
|
137
|
+
3. Verify the `## Contents` section maps sibling pages and immediate child directories.
|
|
138
|
+
4. Flag `overview.md` usage as a migration finding.
|
|
139
|
+
5. Verify single-file directories still expose an `index.md` entrypoint.
|
|
140
|
+
|
|
141
|
+
### Step 3: Assess Quality and Coverage
|
|
142
|
+
|
|
143
|
+
Evaluate each docs page for:
|
|
144
|
+
|
|
145
|
+
- Topic clarity
|
|
146
|
+
- Discoverability from a parent index
|
|
147
|
+
- Command/path accuracy
|
|
148
|
+
- Staleness indicators
|
|
149
|
+
- Excessive duplication
|
|
150
|
+
- Missing contributor guidance for enabled plugins/extensions when an MkDocs app exists
|
|
151
|
+
|
|
152
|
+
Evidence standard:
|
|
153
|
+
|
|
154
|
+
- Every non-obvious docs convention, drift claim, or recommended fix must be backed by
|
|
155
|
+
concrete repo evidence captured in the artifact.
|
|
156
|
+
- Preferred evidence sources are MkDocs config, checked-in docs/app config, package scripts,
|
|
157
|
+
contributor docs, and repeated docs-tree patterns with exact file references.
|
|
158
|
+
- Do **not** infer command accuracy, plugin availability, or navigation policy from defaults.
|
|
159
|
+
- If a command or plugin behavior is already defined in config or setup scripts, prefer
|
|
160
|
+
citing those sources and linking to them rather than restating verbose operational detail
|
|
161
|
+
as always-on docs guidance.
|
|
162
|
+
|
|
163
|
+
For each evaluated page or directory:
|
|
164
|
+
|
|
165
|
+
1. Read the docs file plus the local evidence needed to validate its claims.
|
|
166
|
+
2. Record findings with severity, exact source refs, and confidence.
|
|
167
|
+
3. Decide a disclosure mode for each recommendation:
|
|
168
|
+
- `inline`
|
|
169
|
+
- `link_only`
|
|
170
|
+
- `omit`
|
|
171
|
+
- `ask_user`
|
|
172
|
+
4. Record canonical link targets whenever a `link_only` recommendation is used.
|
|
173
|
+
|
|
174
|
+
In `delta` mode, always evaluate changed docs files plus the nearest parent `index.md` pages.
|
|
175
|
+
In `full` mode, evaluate the whole docs surface.
|
|
176
|
+
|
|
177
|
+
### Step 4: Verify Substantive Claims Against Repo Sources
|
|
178
|
+
|
|
179
|
+
Add a dedicated accuracy verification pass between page-quality assessment and nav/drift checks.
|
|
180
|
+
|
|
181
|
+
Only verify claims that are checkable from within the repository. This includes:
|
|
182
|
+
|
|
183
|
+
- code paths
|
|
184
|
+
- CLI commands and flags
|
|
185
|
+
- API routes
|
|
186
|
+
- config keys and values
|
|
187
|
+
- schema fields / payload fields
|
|
188
|
+
- file names, script names, and setup entrypoints
|
|
189
|
+
|
|
190
|
+
Do **not** attempt to verify:
|
|
191
|
+
|
|
192
|
+
- external URLs
|
|
193
|
+
- behavior that requires running a service
|
|
194
|
+
- claims whose canonical source lives outside the repository
|
|
195
|
+
|
|
196
|
+
For any docs page that references code paths, commands, routes, config keys, field names, or
|
|
197
|
+
other repo-checkable implementation details:
|
|
198
|
+
|
|
199
|
+
1. Identify the claim text and the canonical source that should back it.
|
|
200
|
+
2. Read the backing source files needed to confirm the claim.
|
|
201
|
+
3. Rate the claim as:
|
|
202
|
+
- `verified`
|
|
203
|
+
- `unverified` when the source cannot be found or is too ambiguous
|
|
204
|
+
- `contradicted` when the repo source disagrees with the docs claim
|
|
205
|
+
4. Promote contradicted claims to findings with severity based on likely user harm.
|
|
206
|
+
- Wrong destructive/auth/security guidance -> usually `High` or `Critical`
|
|
207
|
+
- Wrong commands, routes, or required fields that break normal usage -> usually `High`
|
|
208
|
+
- Wrong examples or less harmful operational details -> usually `Medium`
|
|
209
|
+
5. Record unverified claims as `Low` findings with a note that the source could not be confirmed.
|
|
210
|
+
|
|
211
|
+
Evidence standard for this step:
|
|
212
|
+
|
|
213
|
+
- Each checked claim must cite the docs location plus the canonical repo source used to verify it.
|
|
214
|
+
- If multiple repo files are needed to verify a claim, cite all relevant sources.
|
|
215
|
+
- If the canonical source is ambiguous, mark the claim `unverified` rather than guessing.
|
|
216
|
+
|
|
217
|
+
### Step 5: Analyze Content Coverage Opportunities
|
|
218
|
+
|
|
219
|
+
Add a coverage-gap pass after accuracy verification.
|
|
220
|
+
|
|
221
|
+
Build a lightweight inventory of the repo's documentable capability surface using in-repo
|
|
222
|
+
sources only. Prefer:
|
|
223
|
+
|
|
224
|
+
- `app/routers/`, `src/routers/`, or equivalent route/controller modules
|
|
225
|
+
- `app/services/`, `src/services/`, or equivalent business-logic modules
|
|
226
|
+
- the main application entrypoint and route registration files
|
|
227
|
+
- key models, schemas, and config surfaces that define user-facing behavior
|
|
228
|
+
|
|
229
|
+
Do not speculate about future roadmap items or undocumented external integrations.
|
|
230
|
+
|
|
231
|
+
For each significant feature or API capability found in the codebase:
|
|
232
|
+
|
|
233
|
+
1. Capture the capability area and the evidence that proves it exists.
|
|
234
|
+
2. Compare that capability against the docs surface.
|
|
235
|
+
3. Classify the docs state as:
|
|
236
|
+
- adequately covered
|
|
237
|
+
- no coverage
|
|
238
|
+
- thin coverage / stub coverage
|
|
239
|
+
4. For each missing or thinly covered area, produce a scoped content opportunity that includes:
|
|
240
|
+
- capability area name
|
|
241
|
+
- codebase evidence, including router/service/model refs and key route or method signatures
|
|
242
|
+
- suggested docs location:
|
|
243
|
+
- new page
|
|
244
|
+
- expansion of an existing page
|
|
245
|
+
- new section within an existing page
|
|
246
|
+
- severity:
|
|
247
|
+
- `High` if the missing docs would block a typical integrator
|
|
248
|
+
- `Medium` if it is useful but not core to first success
|
|
249
|
+
- `Low` if it is edge-case, admin-only, or internal-only
|
|
250
|
+
|
|
251
|
+
For stub pages that already exist in the docs tree or nav:
|
|
252
|
+
|
|
253
|
+
1. Identify the backing router/service/model evidence.
|
|
254
|
+
2. List the concrete subtopics that should be covered in that page.
|
|
255
|
+
3. Attach those subtopics to the content opportunity so `oat-docs-apply` has a concrete scope to work from.
|
|
256
|
+
|
|
257
|
+
The goal is not just to say "this page is thin," but to say what capability surface is missing,
|
|
258
|
+
where the docs should live, and what specific subtopics the codebase shows should be documented.
|
|
259
|
+
|
|
260
|
+
### Step 6: Check Navigation and Drift
|
|
261
|
+
|
|
262
|
+
If `mkdocs.yml` exists:
|
|
263
|
+
|
|
264
|
+
1. Compare nav entries with the docs tree.
|
|
265
|
+
2. Flag pages present in docs but absent from nav.
|
|
266
|
+
3. Flag nav entries that point at missing pages.
|
|
267
|
+
4. Flag directories whose `index.md` `## Contents` section appears inconsistent with nav structure.
|
|
268
|
+
5. Flag docs guidance that claims structure, plugin support, or workflow rules not backed by current repo evidence.
|
|
269
|
+
|
|
270
|
+
If no `mkdocs.yml` exists, record whether the repo should be migrated to an OAT docs app.
|
|
271
|
+
|
|
272
|
+
### Step 7: Severity-Rate Findings
|
|
273
|
+
|
|
274
|
+
Use these defaults:
|
|
275
|
+
|
|
276
|
+
- `Critical`: misleading docs that could cause destructive or unsafe actions
|
|
277
|
+
- `High`: missing docs app/index coverage for important areas, broken nav, or stale commands that block reliable usage
|
|
278
|
+
- `Medium`: incomplete `## Contents`, `overview.md` still in use, plugin/contributor guidance gaps, moderate duplication
|
|
279
|
+
- `Low`: polish, wording, or organization improvements
|
|
280
|
+
|
|
281
|
+
### Step 8: Write Analysis Artifact
|
|
282
|
+
|
|
283
|
+
Use `references/analysis-artifact-template.md`.
|
|
284
|
+
|
|
285
|
+
```bash
|
|
286
|
+
TIMESTAMP=$(date -u +"%Y-%m-%d-%H%M")
|
|
287
|
+
ARTIFACT_PATH=".oat/repo/analysis/docs-${TIMESTAMP}.md"
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
Populate the artifact with:
|
|
291
|
+
|
|
292
|
+
- Docs target and mode
|
|
293
|
+
- Inventory summary
|
|
294
|
+
- Severity-rated findings
|
|
295
|
+
- Directory coverage and contract gaps
|
|
296
|
+
- Accuracy verification verdicts for repo-checkable claims
|
|
297
|
+
- Content opportunities for missing or thin docs coverage
|
|
298
|
+
- Navigation/drift findings
|
|
299
|
+
- Ordered recommendations
|
|
300
|
+
- Exact evidence references for each finding and recommendation
|
|
301
|
+
- Confidence for each recommendation
|
|
302
|
+
- Progressive disclosure decisions (`inline`, `link_only`, `omit`, `ask_user`)
|
|
303
|
+
- Canonical link targets when deeper detail should stay out of always-on docs pages
|
|
304
|
+
|
|
305
|
+
### Step 9: Update Tracking and Output Summary
|
|
306
|
+
|
|
307
|
+
Update docs tracking using the shared helper:
|
|
308
|
+
|
|
309
|
+
```bash
|
|
310
|
+
TRACKING_SCRIPT=".oat/scripts/resolve-tracking.sh"
|
|
311
|
+
ROOT_TARGET=$(bash "$TRACKING_SCRIPT" root)
|
|
312
|
+
ROOT_HASH=$(echo "$ROOT_TARGET" | jq -r '.commitHash')
|
|
313
|
+
ROOT_BRANCH=$(echo "$ROOT_TARGET" | jq -r '.baseBranch')
|
|
314
|
+
|
|
315
|
+
bash "$TRACKING_SCRIPT" write \
|
|
316
|
+
docs \
|
|
317
|
+
"$ROOT_HASH" \
|
|
318
|
+
"$ROOT_BRANCH" \
|
|
319
|
+
"{mode}" \
|
|
320
|
+
--artifact-path "$ARTIFACT_PATH"
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
Output a summary:
|
|
324
|
+
|
|
325
|
+
```text
|
|
326
|
+
Analysis complete.
|
|
327
|
+
|
|
328
|
+
Docs target: {path}
|
|
329
|
+
Surface type: {mkdocs-app|docs-tree|root-markdown}
|
|
330
|
+
Files evaluated: {N}
|
|
331
|
+
Mode: {full|delta}
|
|
332
|
+
|
|
333
|
+
Findings:
|
|
334
|
+
Critical: {N}
|
|
335
|
+
High: {N}
|
|
336
|
+
Medium: {N}
|
|
337
|
+
Low: {N}
|
|
338
|
+
|
|
339
|
+
Artifact: {artifact_path}
|
|
340
|
+
|
|
341
|
+
Next step: Run oat-docs-apply to act on these findings.
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
## Deferred from v1
|
|
345
|
+
|
|
346
|
+
- Automatic topic clustering for large legacy docs trees
|
|
347
|
+
- Heuristic ranking of "most important" missing indexes
|
|
348
|
+
- Direct generation of docs scaffolding without an apply review step
|
|
349
|
+
|
|
350
|
+
## References
|
|
351
|
+
|
|
352
|
+
- Analysis artifact template: `references/analysis-artifact-template.md`
|
|
353
|
+
- Quality checklist: `references/quality-checklist.md`
|
|
354
|
+
- Directory criteria: `references/directory-assessment-criteria.md`
|
|
355
|
+
- Shared tracking helper: `.oat/scripts/resolve-tracking.sh`
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
---
|
|
2
|
+
oat_generated: true
|
|
3
|
+
oat_generated_at: { YYYY-MM-DD }
|
|
4
|
+
oat_analysis_type: docs
|
|
5
|
+
oat_analysis_mode: { full|delta }
|
|
6
|
+
oat_docs_target: { docs-target-path }
|
|
7
|
+
oat_analysis_commit: { commitHash }
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Docs Analysis: {repo-name}
|
|
11
|
+
|
|
12
|
+
**Date:** {YYYY-MM-DD}
|
|
13
|
+
**Mode:** {full|delta}
|
|
14
|
+
**Docs Target:** `{docs-target-path}`
|
|
15
|
+
**Surface Type:** {mkdocs-app|docs-tree|root-markdown}
|
|
16
|
+
**Commit:** {short-hash}
|
|
17
|
+
|
|
18
|
+
## Summary
|
|
19
|
+
|
|
20
|
+
- **Files evaluated:** {N}
|
|
21
|
+
- **Directories assessed:** {N}
|
|
22
|
+
- **Index coverage:** {N}% of docs directories contain `index.md`
|
|
23
|
+
- **Findings:** {N} Critical, {N} High, {N} Medium, {N} Low
|
|
24
|
+
- **Delta scope:** {N/A or "N files changed since {base-commit}"}
|
|
25
|
+
- **Evidence-backed recommendations:** {N}
|
|
26
|
+
- **Open questions / ask-user items:** {N}
|
|
27
|
+
- **Contradicted claims:** {N}
|
|
28
|
+
- **Coverage gaps / content opportunities:** {N}
|
|
29
|
+
|
|
30
|
+
## Docs Inventory
|
|
31
|
+
|
|
32
|
+
| # | Type | Path | Status | Notes |
|
|
33
|
+
| --- | --------- | ------------------------- | ------ | ---------------------- |
|
|
34
|
+
| 1 | index | `docs/index.md` | pass | Root index present |
|
|
35
|
+
| 2 | page | `docs/getting-started.md` | pass | Linked from root index |
|
|
36
|
+
| 3 | directory | `docs/reference/` | issues | Missing `index.md` |
|
|
37
|
+
| ... | | | | |
|
|
38
|
+
|
|
39
|
+
## Findings
|
|
40
|
+
|
|
41
|
+
### Critical
|
|
42
|
+
|
|
43
|
+
{Findings that could mislead agents into unsafe or destructive behavior.}
|
|
44
|
+
|
|
45
|
+
1. **{Title}**
|
|
46
|
+
- File: `{path}:{line}`
|
|
47
|
+
- Issue: {description}
|
|
48
|
+
- Evidence: {exact file refs, config/docs, or representative docs-tree examples}
|
|
49
|
+
- Confidence: {high | medium | low}
|
|
50
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
51
|
+
- Link Target: {path or URL when disclosure is link_only; otherwise "N/A"}
|
|
52
|
+
- Fix: {specific guidance}
|
|
53
|
+
|
|
54
|
+
None | {numbered list}
|
|
55
|
+
|
|
56
|
+
### High
|
|
57
|
+
|
|
58
|
+
{Broken or missing docs structure that blocks reliable discovery or usage.}
|
|
59
|
+
|
|
60
|
+
1. **{Title}**
|
|
61
|
+
- File: `{path}:{line}`
|
|
62
|
+
- Issue: {description}
|
|
63
|
+
- Evidence: {exact file refs, config/docs, or representative docs-tree examples}
|
|
64
|
+
- Confidence: {high | medium | low}
|
|
65
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
66
|
+
- Link Target: {path or URL when disclosure is link_only; otherwise "N/A"}
|
|
67
|
+
- Fix: {specific guidance}
|
|
68
|
+
|
|
69
|
+
None | {numbered list}
|
|
70
|
+
|
|
71
|
+
### Medium
|
|
72
|
+
|
|
73
|
+
{Contract, navigation, or contributor-guidance issues that materially reduce quality.}
|
|
74
|
+
|
|
75
|
+
1. **{Title}**
|
|
76
|
+
- File: `{path}:{line}`
|
|
77
|
+
- Issue: {description}
|
|
78
|
+
- Evidence: {exact file refs, config/docs, or representative docs-tree examples}
|
|
79
|
+
- Confidence: {high | medium | low}
|
|
80
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
81
|
+
- Link Target: {path or URL when disclosure is link_only; otherwise "N/A"}
|
|
82
|
+
- Fix: {specific guidance}
|
|
83
|
+
|
|
84
|
+
None | {numbered list}
|
|
85
|
+
|
|
86
|
+
### Low
|
|
87
|
+
|
|
88
|
+
{Polish, wording, and smaller organizational issues.}
|
|
89
|
+
|
|
90
|
+
1. **{Title}**
|
|
91
|
+
- File: `{path}:{line}`
|
|
92
|
+
- Issue: {description}
|
|
93
|
+
- Evidence: {exact file refs, config/docs, or representative docs-tree examples}
|
|
94
|
+
- Confidence: {high | medium | low}
|
|
95
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
96
|
+
- Link Target: {path or URL when disclosure is link_only; otherwise "N/A"}
|
|
97
|
+
- Fix: {specific guidance}
|
|
98
|
+
|
|
99
|
+
None | {numbered list}
|
|
100
|
+
|
|
101
|
+
## Directory Contract Gaps
|
|
102
|
+
|
|
103
|
+
| # | Directory | Gap | Evidence | Disclosure | Link Target | Severity | Recommended Fix |
|
|
104
|
+
| --- | ----------- | --------------------------- | ------------ | -------------------------------- | ------------------- | -------- | ------------------------------------------ |
|
|
105
|
+
| 1 | `docs/api/` | Missing `index.md` | {exact refs} | {inline/link_only/omit/ask_user} | {path or URL / N/A} | High | Add `index.md` with `## Contents` |
|
|
106
|
+
| 2 | `docs/cli/` | `overview.md` still present | {exact refs} | {inline/link_only/omit/ask_user} | {path or URL / N/A} | Medium | Convert to `index.md` or linked topic page |
|
|
107
|
+
| ... | | | | | | | |
|
|
108
|
+
|
|
109
|
+
{Or: "No directory contract gaps identified."}
|
|
110
|
+
|
|
111
|
+
## Accuracy Verification
|
|
112
|
+
|
|
113
|
+
Check only claims that are verifiable from repo sources such as code, config, schemas,
|
|
114
|
+
scripts, route definitions, and checked-in setup files. Do not include external URLs or
|
|
115
|
+
runtime-only behavior here.
|
|
116
|
+
|
|
117
|
+
| # | Docs Claim | Docs Ref | Canonical Source Ref | Verdict | Severity | Notes |
|
|
118
|
+
| --- | -------------- | --------------------- | -------------------- | ---------------------------------------- | ------------------------------------------ | ------------------------------------------------ |
|
|
119
|
+
| 1 | `{claim text}` | `{docs/path.md:line}` | `{src/path.ts:line}` | {verified \| unverified \| contradicted} | {Critical \| High \| Medium \| Low \| N/A} | {why it was judged this way} |
|
|
120
|
+
| 2 | `{claim text}` | `{docs/path.md:line}` | `{config/file:line}` | {verified \| unverified \| contradicted} | {Critical \| High \| Medium \| Low \| N/A} | {source missing, ambiguous, or contradicts docs} |
|
|
121
|
+
| ... | | | | | | |
|
|
122
|
+
|
|
123
|
+
{Or: "No repo-checkable substantive claims required accuracy verification."}
|
|
124
|
+
|
|
125
|
+
## Content Opportunities
|
|
126
|
+
|
|
127
|
+
Surface only repo-checkable coverage gaps based on routers, services, models, schemas,
|
|
128
|
+
config, and application entrypoints. Do not speculate about roadmap items or external
|
|
129
|
+
integrations that are not represented in the repository.
|
|
130
|
+
|
|
131
|
+
| # | Capability Area | Coverage State | Codebase Evidence | Suggested Docs Location | Severity | Subtopics To Cover |
|
|
132
|
+
| --- | ------------------------------ | ------------------------------ | ------------------------------------------------ | -------------------------------------- | ----------------------- | ------------------------------------------ |
|
|
133
|
+
| 1 | `{feature or capability area}` | {no coverage \| thin coverage} | `{router/service/model refs and key signatures}` | `{new page / existing page / section}` | {High \| Medium \| Low} | `{specific subtopics implied by the code}` |
|
|
134
|
+
| 2 | `{feature or capability area}` | {no coverage \| thin coverage} | `{router/service/model refs and key signatures}` | `{new page / existing page / section}` | {High \| Medium \| Low} | `{specific subtopics implied by the code}` |
|
|
135
|
+
| ... | | | | | | |
|
|
136
|
+
|
|
137
|
+
{Or: "No significant repo-backed content opportunities identified."}
|
|
138
|
+
|
|
139
|
+
## Navigation and Drift
|
|
140
|
+
|
|
141
|
+
| # | Surface | Issue | Evidence | Disclosure | Link Target | Severity | Notes |
|
|
142
|
+
| --- | --------------- | ------------------------------------- | ------------ | -------------------------------- | ------------------- | -------- | -------------------------------------- |
|
|
143
|
+
| 1 | `mkdocs.yml` | Nav points to missing page | {exact refs} | {inline/link_only/omit/ask_user} | {path or URL / N/A} | High | `reference/troubleshooting.md` removed |
|
|
144
|
+
| 2 | `docs/index.md` | `## Contents` missing subtree mapping | {exact refs} | {inline/link_only/omit/ask_user} | {path or URL / N/A} | Medium | Child directory not described |
|
|
145
|
+
| ... | | | | | | | |
|
|
146
|
+
|
|
147
|
+
{Or: "No navigation or drift issues identified."}
|
|
148
|
+
|
|
149
|
+
## Progressive Disclosure Decisions
|
|
150
|
+
|
|
151
|
+
Capture which details should stay inline in docs indexes/contributor pages versus link to
|
|
152
|
+
canonical docs/config/examples.
|
|
153
|
+
|
|
154
|
+
| Topic | Decision | Keep Inline In | Link Target | Evidence |
|
|
155
|
+
| --------- | -------------------------------- | ------------------------------------- | --------------- | ------------ |
|
|
156
|
+
| `{topic}` | {inline/link_only/omit/ask_user} | `{index.md / contributing.md / page}` | `{path or URL}` | {exact refs} |
|
|
157
|
+
| ... | | | | |
|
|
158
|
+
|
|
159
|
+
{Or: "No additional progressive disclosure decisions beyond the findings/recommendations below."}
|
|
160
|
+
|
|
161
|
+
## Recommendations
|
|
162
|
+
|
|
163
|
+
1. **{Action}** — {rationale}
|
|
164
|
+
- Target: `{path}`
|
|
165
|
+
- Action Type: {create / update / move / scaffold / sync-nav}
|
|
166
|
+
- Evidence: {exact refs}
|
|
167
|
+
- Confidence: {high | medium | low}
|
|
168
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
169
|
+
- Link Targets: {path or URL / N/A}
|
|
170
|
+
2. **{Action}** — {rationale}
|
|
171
|
+
- Target: `{path}`
|
|
172
|
+
- Action Type: {create / update / move / scaffold / sync-nav}
|
|
173
|
+
- Evidence: {exact refs}
|
|
174
|
+
- Confidence: {high | medium | low}
|
|
175
|
+
- Disclosure: {inline | link_only | omit | ask_user}
|
|
176
|
+
- Link Targets: {path or URL / N/A}
|
|
177
|
+
3. ...
|
|
178
|
+
|
|
179
|
+
## Apply Contract
|
|
180
|
+
|
|
181
|
+
- `oat-docs-apply` may only implement recommendations backed by evidence in this artifact.
|
|
182
|
+
- Findings based on contradicted claims must be resolved against cited repo sources before `oat-docs-apply` acts on them.
|
|
183
|
+
- Content opportunity recommendations require `oat-docs-apply` to read the cited router/service/model files before generating prose; it must not synthesize feature coverage from memory.
|
|
184
|
+
- Recommendations marked `omit` must stay out of generated docs changes.
|
|
185
|
+
- Recommendations marked `ask_user` require explicit user confirmation before generation.
|
|
186
|
+
- Recommendations marked `link_only` must include a canonical link target.
|
|
187
|
+
- If cited config/docs/files are missing at apply time, stop and re-run analyze or ask the user rather than inventing a replacement convention.
|
|
188
|
+
- When docs guidance already lives in canonical setup/config docs, generated changes should prefer concise links over duplicating the full detail inline.
|
|
189
|
+
|
|
190
|
+
## Next Step
|
|
191
|
+
|
|
192
|
+
Run `oat-docs-apply` with this artifact to approve and apply the recommended documentation changes.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Docs Directory Assessment Criteria
|
|
2
|
+
|
|
3
|
+
Use these criteria to determine whether a directory should have its own `index.md` and how strongly missing coverage should be rated.
|
|
4
|
+
|
|
5
|
+
## Primary indicators
|
|
6
|
+
|
|
7
|
+
Treat a directory as a docs node when one or more of these is true:
|
|
8
|
+
|
|
9
|
+
- It contains one or more Markdown files.
|
|
10
|
+
- It has child directories that contain Markdown files.
|
|
11
|
+
- It represents a distinct product, package, workflow, or topic area.
|
|
12
|
+
- It is linked from another docs page as a navigable subsection.
|
|
13
|
+
|
|
14
|
+
## Severity guidance
|
|
15
|
+
|
|
16
|
+
### High
|
|
17
|
+
|
|
18
|
+
Use `High` when the directory:
|
|
19
|
+
|
|
20
|
+
- Is a top-level docs section with no `index.md`
|
|
21
|
+
- Contains multiple pages or subtrees but lacks a local map
|
|
22
|
+
- Is important to setup, operations, or contributor workflows
|
|
23
|
+
|
|
24
|
+
### Medium
|
|
25
|
+
|
|
26
|
+
Use `Medium` when the directory:
|
|
27
|
+
|
|
28
|
+
- Has an `index.md` but no useful `## Contents`
|
|
29
|
+
- Still uses `overview.md` as the directory entrypoint
|
|
30
|
+
- Has a partial map that omits key siblings or child directories
|
|
31
|
+
|
|
32
|
+
### Low
|
|
33
|
+
|
|
34
|
+
Use `Low` when the directory:
|
|
35
|
+
|
|
36
|
+
- Is technically covered but the descriptions are vague
|
|
37
|
+
- Has minor organization issues that do not block discovery
|
|
38
|
+
|
|
39
|
+
## Exclusions
|
|
40
|
+
|
|
41
|
+
Do not require `index.md` for:
|
|
42
|
+
|
|
43
|
+
- `node_modules/`
|
|
44
|
+
- `site/`
|
|
45
|
+
- build output directories
|
|
46
|
+
- hidden tool directories that are not part of the docs surface
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Docs Quality Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist when evaluating a docs surface.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
- Every docs directory has an `index.md`.
|
|
8
|
+
- Every `index.md` includes a `## Contents` section.
|
|
9
|
+
- `## Contents` links describe sibling files and immediate child directories.
|
|
10
|
+
- `overview.md` is not used as the directory entrypoint.
|
|
11
|
+
|
|
12
|
+
## Accuracy
|
|
13
|
+
|
|
14
|
+
- Commands match the current repo scripts and CLI surface.
|
|
15
|
+
- Referenced paths exist.
|
|
16
|
+
- Tooling/setup instructions are current.
|
|
17
|
+
|
|
18
|
+
## Discoverability
|
|
19
|
+
|
|
20
|
+
- Important pages are reachable from a parent `index.md` or site nav.
|
|
21
|
+
- Topic names are specific enough for agents to select the right page quickly.
|
|
22
|
+
- Large sections summarize what each child page covers.
|
|
23
|
+
|
|
24
|
+
## Docs App Contract
|
|
25
|
+
|
|
26
|
+
- `mkdocs.yml` exists when the repo is using an OAT docs app.
|
|
27
|
+
- Navigation is consistent with the docs tree.
|
|
28
|
+
- `docs/contributing.md` documents enabled plugins/extensions when an MkDocs app exists.
|
|
29
|
+
|
|
30
|
+
## Claims Are Evidence-Backed
|
|
31
|
+
|
|
32
|
+
- Non-obvious docs conventions are backed by concrete repo sources.
|
|
33
|
+
- Command, plugin, and nav claims cite config, setup docs, or repeated tree patterns.
|
|
34
|
+
- When canonical setup/config docs already exist, indexes and contributor docs prefer concise links over duplicating every detail inline.
|
|
35
|
+
|
|
36
|
+
## Progressive Disclosure
|
|
37
|
+
|
|
38
|
+
- Always-on docs pages keep only the minimal essential guidance inline.
|
|
39
|
+
- Deeper detail links to canonical docs, config, or examples instead of being copied into every index.
|
|
40
|
+
- `link_only`, `omit`, and `ask_user` decisions are used when that keeps the docs surface more accurate and maintainable.
|
|
41
|
+
|
|
42
|
+
## Drift Signals
|
|
43
|
+
|
|
44
|
+
- Nav points to missing files.
|
|
45
|
+
- Files exist but are not represented in indexes/nav.
|
|
46
|
+
- Index descriptions no longer match the content they point to.
|
|
47
|
+
- Commands mention removed or renamed tooling.
|
|
48
|
+
- Docs claim plugin support or structure rules that are not backed by current repo evidence.
|