@open-agent-toolkit/cli 0.0.37 → 0.0.39

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.
@@ -144,6 +144,10 @@ Key behavior:
144
144
  The `docs` pack contains active documentation and instruction-governance
145
145
  workflows:
146
146
 
147
+ - **oat-docs-bootstrap** — Guide users through bootstrapping a docs app
148
+ end-to-end: preflight detection, input gathering, scaffold (via `oat docs
149
+ init`) with capability-gated post-patches, build verification, config
150
+ inspection, and an educational walkthrough.
147
151
  - **oat-docs-analyze** — Analyze a docs surface for contract coverage, nav
148
152
  drift, stale claims, and coverage gaps.
149
153
  - **oat-docs-apply** — Apply only approved, evidence-backed docs-analysis
@@ -52,6 +52,36 @@ quickstart, the docs pair is the part you need immediately.
52
52
 
53
53
  ## 3. Scaffold the docs app
54
54
 
55
+ Two paths — pick one:
56
+
57
+ ### 3a. Preferred: the `oat-docs-bootstrap` skill (guided)
58
+
59
+ ```text
60
+ /oat-docs-bootstrap
61
+ ```
62
+
63
+ The docs-bootstrap skill wraps `oat docs init` with a seven-step guided flow: preflight detection (repo shape + existing-setup conflict surfacing), richer input gathering (including a site name distinct from the package name), the CLI invocation itself, labeled post-patches for open CLI gaps, install + build verification, post-scaffold config inspection, and a chunked educational walkthrough.
64
+
65
+ What the skill adds over the raw CLI:
66
+
67
+ - **Preflight + conflict resolution.** Detects existing `documentation` config / docs app dir / root `AGENTS.md` section and walks a deliberate resolution choice (replace, abort, repair, or deferred second-app) before any mutation.
68
+ - **Richer inputs.** Asks for a **site name** separate from the package name, so `createDocsConfig()` / layout branding / page metadata all converge on the same display title.
69
+ - **Post-scaffold patches for open CLI gaps.** Applied only when capability detection shows the CLI hasn't closed the gap. Each patch is labeled (e.g., `<!-- FP-12 patch -->`) so it can be removed deterministically when the upstream fix lands:
70
+ - **FP-11** — Turbopack `root` for nested-standalone Fumadocs apps (suppresses the multiple-lockfile warning)
71
+ - **FP-12** — `export const metadata = { title, description }` in `app/layout.tsx` (the only thing that populates page `<title>`, meta description, and Open Graph — `DocsLayout.branding.title` only renders nav chrome, and `createDocsConfig()` ignores `title` / `description` entirely)
72
+ - **FP-13** — five scaffold-content fixes (empty per-page `description:` frontmatter, bare install/build commands missing `--filter` or `cd`-prefix for monorepo/nested shapes, false `docs:lint` claim when `lint=none`, missing "do not hand-edit" header on generated `index.md`, Node version line that doesn't match the consuming repo's `.nvmrc` / `engines.node`)
73
+ - **FP-15** — writes a task-framed `<appRoot>/AGENTS.md` bridge file when the CLI hasn't scaffolded one. The bridge is the docs app's runtime agent reference (separate audience from `docs/contributing.md`)
74
+ - **FP-16** — rewrites `docs/index.md` `## Contents` links to the `.md`-suffixed form that `@open-agent-toolkit/docs-transforms` normalizes at build time (agent-friendlier than extension-less; routes correctly)
75
+ - **FP-17** — trims `docs/contributing.md`'s "Agent guidance" section to a one-line pointer at the docs-app `AGENTS.md`, restoring the three-surfaces separation
76
+ - **Build verification.** Runs install + build, classifies failures against known patterns, stops on unknown errors rather than guessing.
77
+ - **Config inspection.** Reads `.oat/config.json` back, verifies paths exist on disk, handles the nested-standalone dual-config case, and collects the `requireForProjectCompletion` opt-in explicitly.
78
+ - **Educational walkthrough.** Seven sections covering the `documentation` config, the two-`index.md` model, the `## Contents` contract (with extension discipline), the three agent-instruction surfaces (root `AGENTS.md` pointer / docs-app `AGENTS.md` / `docs/contributing.md`), Fumadocs internals (or MkDocs Minimum Contract), and the OAT docs ecosystem (`oat-project-document`, `oat-docs-analyze`, `oat-docs-apply`).
79
+ - **Optional content kickoff.** Hands off to `oat-docs-analyze` + `oat-docs-apply` if you want to populate initial repo-specific content immediately.
80
+
81
+ Capability-gated: every post-patch self-ratchets off as CLI fixes land upstream. The skill's labeled markers (`<!-- FP-NN patch -->`) are how you find them later when the CLI catches up.
82
+
83
+ ### 3b. Direct CLI (deterministic / non-interactive)
84
+
55
85
  ```bash
56
86
  oat docs init --app-name my-docs
57
87
  ```
@@ -76,6 +106,8 @@ oat docs init --app-name my-docs --framework fumadocs --yes
76
106
  oat docs init --app-name my-docs --framework mkdocs --yes
77
107
  ```
78
108
 
109
+ Use 3b when you want a fully headless scaffold (CI, automation) and can accept the raw CLI output without the guided post-patches.
110
+
79
111
  ## 3a. Migrating from MkDocs (optional)
80
112
 
81
113
  If you have an existing MkDocs site and want to switch to Fumadocs, use the
@@ -30,6 +30,8 @@ and **MkDocs Material**.
30
30
 
31
31
  Use `oat docs init` to scaffold a docs app that follows the OAT docs contract.
32
32
 
33
+ > **Consider the `oat-docs-bootstrap` skill instead.** The skill wraps `oat docs init` with preflight detection, richer input gathering (site name distinct from package name), capability-gated post-patches that close open CLI gaps (site-title metadata, Turbopack root, template-content fixes, docs-app `AGENTS.md` bridge, `## Contents` link extensions, `contributing.md` three-surfaces cleanup), build verification, config inspection, and a seven-section educational walkthrough. See [Add Docs to a Repo §3a](add-docs-to-a-repo.md#3a-preferred-the-oat-docs-bootstrap-skill-guided) for the full flow. The CLI documented here remains the authoritative surface for flags and is the right choice when you need a deterministic, non-interactive scaffold (CI, automation).
34
+
33
35
  Key behavior:
34
36
 
35
37
  - prompts for framework choice (Fumadocs or MkDocs) in interactive mode
@@ -23,6 +23,10 @@ Install the workflow skills with `oat tools install docs` (preferred) or
23
23
 
24
24
  ### Skills
25
25
 
26
+ - `oat-docs-bootstrap` is the guided onramp for adding a docs app to a repo —
27
+ wraps `oat docs init` with preflight detection, richer input gathering (site
28
+ name distinct from package name), labeled post-patches for open CLI gaps,
29
+ build verification, config inspection, and an educational walkthrough
26
30
  - `oat-docs-analyze` evaluates a docs surface for structure, drift, coverage,
27
31
  contributor guidance, and docs-app contract issues
28
32
  - `oat-docs-apply` consumes the analysis artifact and applies only approved,
@@ -45,7 +49,7 @@ skills.
45
49
 
46
50
  ## Typical flow
47
51
 
48
- 1. Bootstrap a docs app with `oat docs init` (choose Fumadocs or MkDocs)
52
+ 1. Bootstrap a docs app with `oat-docs-bootstrap` (preferred — guided, includes post-scaffold patches and walkthrough) or `oat docs init` directly (CLI-only / non-interactive workflows)
49
53
  2. (Optional) If migrating from MkDocs: `oat docs migrate --docs-dir docs --config mkdocs.yml --apply`
50
54
  3. Author docs so every directory has an `index.md` with a `## Contents` section
51
55
  4. Keep local `## Contents` sections current
@@ -21,7 +21,7 @@ Use this section when you want to choose the right OAT skill for a task. If you
21
21
  - Retroactively capture existing work: `oat-project-capture`
22
22
  - Run or receive reviews: `oat-project-review-provide`, `oat-project-review-receive`, or the non-project review variants
23
23
  - Manage the repo backlog and reference docs: `oat-pjm-add-backlog-item`, `oat-pjm-update-repo-reference`, `oat-pjm-review-backlog`
24
- - Work on docs surfaces: `oat-docs-analyze`, `oat-docs-apply`, and `oat-project-document`
24
+ - Work on docs surfaces: `oat-docs-bootstrap` (guided bootstrap of a new docs app), `oat-docs-analyze`, `oat-docs-apply`, and `oat-project-document`
25
25
  - Generate a shipping digest or scheduled recap: `oat-wrap-up`
26
26
  - Research a topic in depth: `deep-research`
27
27
  - Analyze an artifact, codebase, or document: `analyze`
@@ -75,6 +75,7 @@ Use this section when you want to choose the right OAT skill for a task. If you
75
75
 
76
76
  === "Docs and instructions"
77
77
 
78
+ - `oat-docs-bootstrap`
78
79
  - `oat-docs-analyze`
79
80
  - `oat-docs-apply`
80
81
  - `oat-agent-instructions-analyze`
@@ -1,6 +1,6 @@
1
1
  {
2
- "cli": "0.0.37",
3
- "docs-config": "0.0.37",
4
- "docs-theme": "0.0.37",
5
- "docs-transforms": "0.0.37"
2
+ "cli": "0.0.39",
3
+ "docs-config": "0.0.39",
4
+ "docs-theme": "0.0.39",
5
+ "docs-transforms": "0.0.39"
6
6
  }