Skip to content

docs: split docs workflows into a dedicated tool pack#87

Merged
tkstang merged 23 commits intomainfrom
docs-pack-split
Mar 21, 2026
Merged

docs: split docs workflows into a dedicated tool pack#87
tkstang merged 23 commits intomainfrom
docs-pack-split

Conversation

@tkstang
Copy link
Copy Markdown
Owner

@tkstang tkstang commented Mar 20, 2026

docs: split docs workflows into a dedicated tool pack

Summary

This change introduces a first-class docs tool pack for active documentation
and agent-instruction workflows while keeping foundational oat-docs access in
core. The CLI now recognizes the new pack across install, scan, update,
remove, and help flows, and the shared tracking helper was moved to a neutral
.oat/scripts location so the split does not leave behind hidden cross-pack
dependencies. Product docs and oat-doctor guidance were updated to match the
new pack model, and final review follow-up fixes closed the last taxonomy and
manifest drift.

Quick workflow note: this project ran in quick mode, so this PR is grounded in
discovery.md, plan.md, implementation.md, and the final passed review
rather than spec/design artifacts.

Goals / Non-Goals

  • Goals:
    • Create a dedicated docs pack for oat-docs-analyze,
      oat-docs-apply, oat-agent-instructions-analyze, and
      oat-agent-instructions-apply
    • Keep oat-docs in core
    • Update install, list, scan, update, remove, help, and user docs together
    • Remove the hidden helper-path dependency between docs and
      agent-instructions skills
  • Non-goals:
    • Reworking the underlying behavior of docs or agent-instructions workflows
    • Reorganizing unrelated packs beyond the docs split
    • Adding new documentation features beyond pack-alignment updates

Changes

  • CLI pack model:
    • Added a first-class docs pack manifest and installer path under
      oat init tools
    • Kept oat-docs in core while moving the analyze/apply workflows into the
      new docs pack
    • Updated pack-aware tests and bundle-consistency coverage for the new split
  • Tool lifecycle support:
    • Propagated docs through installed-tool scanning and pack typing so moved
      skills no longer appear as custom
    • Updated oat tools update, oat tools remove, and legacy
      oat remove skills --pack flows to accept docs
    • Refreshed help snapshots and pack descriptions to reflect the new taxonomy
  • Shared asset decoupling:
    • Moved the tracking resolver to .oat/scripts/resolve-tracking.sh
    • Updated docs, agent-instructions, and repo-knowledge-index skill references
      to use the neutral helper location
    • Updated asset bundling and installer logic so shared scripts install with
      the correct pack
  • Docs and guidance:
    • Updated repo and docs-site guidance to present docs as a first-class pack
    • Switched docs workflow onboarding to recommend oat tools install docs
    • Brought oat-doctor guidance and summary examples back into sync with the
      full supported pack set
  • Review fixes:
    • Corrected the stale utility description after the split
    • Completed missing project-management and research coverage in the
      oat-doctor summary-mode manifest and example output

Verification

  • pnpm --filter @oat/cli exec vitest run src/commands/init/tools/docs/install-docs.test.ts src/commands/init/tools/docs/index.test.ts src/commands/init/tools/index.test.ts src/commands/init/tools/shared/bundle-consistency.test.ts
  • pnpm --filter @oat/cli exec vitest run src/commands/tools/shared/scan-tools.test.ts src/commands/tools/list/list-tools.test.ts src/commands/tools/update/update-tools.test.ts src/commands/tools/remove/remove-tools.test.ts src/commands/remove/skills/remove-skills.test.ts src/commands/help-snapshots.test.ts
  • pnpm --filter @oat/cli exec vitest run src/commands/init/tools/docs/install-docs.test.ts src/commands/init/tools/docs/index.test.ts src/commands/init/tools/workflows/install-workflows.test.ts
  • pnpm --filter @oat/cli lint
  • pnpm --filter @oat/cli type-check
  • pnpm --filter oat-docs docs:lint
  • pnpm build:docs
  • Targeted rg checks for stale pack-taxonomy and helper-path references

Reviews

Scope Type Status Date Artifact
final code passed 2026-03-20 reviews/archived/final-review-2026-03-20-v3.md

References

@tkstang tkstang merged commit 4eed6fa into main Mar 21, 2026
1 check passed
@tkstang tkstang deleted the docs-pack-split branch March 21, 2026 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant