@brucewaynedecoy/make-docs 2.0.2 → 2.0.4

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.
Files changed (46) hide show
  1. package/README.md +30 -75
  2. package/dist/{backup-73HQNKMC.js → backup-CM7RL2Q7.js} +5 -5
  3. package/dist/chunk-3EXHM5L2.js +1225 -0
  4. package/dist/chunk-3EXHM5L2.js.map +1 -0
  5. package/dist/{chunk-LVQSJF63.js → chunk-52FTNVXS.js} +242 -76
  6. package/dist/{chunk-LVQSJF63.js.map → chunk-52FTNVXS.js.map} +1 -1
  7. package/dist/{chunk-LQ5NSWCJ.js → chunk-65QWMODG.js} +2 -2
  8. package/dist/{chunk-HJYIQTMD.js → chunk-7R2PPKTB.js} +2 -2
  9. package/dist/{chunk-BENO4IH5.js → chunk-ADVNSMA7.js} +3 -3
  10. package/dist/{chunk-G5EF63GG.js → chunk-GERMRLJ2.js} +2 -2
  11. package/dist/{chunk-3BAJQXGH.js → chunk-J5QDGRZ7.js} +3 -3
  12. package/dist/{chunk-GNP6HRVP.js → chunk-LV3CBXZB.js} +20 -20
  13. package/dist/{chunk-GNP6HRVP.js.map → chunk-LV3CBXZB.js.map} +1 -1
  14. package/dist/{chunk-LRVV7UDD.js → chunk-M7DMFIKU.js} +2 -2
  15. package/dist/{chunk-64CTKJO7.js → chunk-OR5ZVGLG.js} +6 -5
  16. package/dist/chunk-OR5ZVGLG.js.map +1 -0
  17. package/dist/{chunk-MXBHCHSM.js → chunk-YVSASZMT.js} +3 -3
  18. package/dist/chunk-YVSASZMT.js.map +1 -0
  19. package/dist/index.js +118 -110
  20. package/dist/index.js.map +1 -1
  21. package/dist/{self-YYXOLDKU.js → self-36ULRIJ6.js} +17 -17
  22. package/dist/{self-YYXOLDKU.js.map → self-36ULRIJ6.js.map} +1 -1
  23. package/dist/{server-O2ZELIMX.js → server-H754TA4Q.js} +9 -9
  24. package/dist/{setup-system-HZROFNMP.js → setup-system-JI36YJ6D.js} +15 -15
  25. package/dist/{setup-system-HZROFNMP.js.map → setup-system-JI36YJ6D.js.map} +1 -1
  26. package/dist/{skills-command-MGGHY7HU.js → skills-command-IGDVLNKY.js} +28 -28
  27. package/dist/{skills-command-MGGHY7HU.js.map → skills-command-IGDVLNKY.js.map} +1 -1
  28. package/dist/{uninstall-3UXXXNFO.js → uninstall-VBGMQQLA.js} +8 -8
  29. package/dist/{virtual_make-docs-first-party-skills-ZII74YOB.js → virtual_make-docs-first-party-skills-H3FC47C2.js} +2 -2
  30. package/dist/{virtual_make-docs-first-party-skills-ZII74YOB.js.map → virtual_make-docs-first-party-skills-H3FC47C2.js.map} +1 -1
  31. package/package.json +4 -4
  32. package/template/.make-docs/system/contracts/output-contract.md +3 -1
  33. package/template/.make-docs/system/references/prd-change-management.md +14 -2
  34. package/dist/chunk-64CTKJO7.js.map +0 -1
  35. package/dist/chunk-MXBHCHSM.js.map +0 -1
  36. package/dist/chunk-Z5K4FHYP.js +0 -922
  37. package/dist/chunk-Z5K4FHYP.js.map +0 -1
  38. /package/dist/{backup-73HQNKMC.js.map → backup-CM7RL2Q7.js.map} +0 -0
  39. /package/dist/{chunk-LQ5NSWCJ.js.map → chunk-65QWMODG.js.map} +0 -0
  40. /package/dist/{chunk-HJYIQTMD.js.map → chunk-7R2PPKTB.js.map} +0 -0
  41. /package/dist/{chunk-BENO4IH5.js.map → chunk-ADVNSMA7.js.map} +0 -0
  42. /package/dist/{chunk-G5EF63GG.js.map → chunk-GERMRLJ2.js.map} +0 -0
  43. /package/dist/{chunk-3BAJQXGH.js.map → chunk-J5QDGRZ7.js.map} +0 -0
  44. /package/dist/{chunk-LRVV7UDD.js.map → chunk-M7DMFIKU.js.map} +0 -0
  45. /package/dist/{server-O2ZELIMX.js.map → server-H754TA4Q.js.map} +0 -0
  46. /package/dist/{uninstall-3UXXXNFO.js.map → uninstall-VBGMQQLA.js.map} +0 -0
package/README.md CHANGED
@@ -1,102 +1,57 @@
1
1
  # Make Docs
2
2
 
3
- Install a structured documentation system into any project with a single CLI command. `make-docs` creates a documentation tree for PRDs, plans, design records, work backlogs, reusable templates, prompt starters, and AI agent instruction routers.
3
+ Make Docs helps teams plan, build, and keep project documentation current with AI agents. It provides a CLI, an MCP server, document templates, system resources, and optional agent Skills. Project knowledge stays in the project repository.
4
4
 
5
5
  ## Quick Start
6
6
 
7
- From the root of the project you want to equip:
7
+ Make Docs 2.0.4 needs Node.js 24 or newer with built-in SQLite, npm, and a project directory. Run these commands from the project directory:
8
8
 
9
9
  ```bash
10
- npx @brucewaynedecoy/make-docs@next
10
+ npx @brucewaynedecoy/make-docs@latest setup --dry-run
11
+ npx @brucewaynedecoy/make-docs@latest setup
11
12
  ```
12
13
 
13
- Bare `make-docs` is context-aware: with no install present it starts a guided setup, and with an install present it shows status and help without syncing. For a non-interactive install with the default profile:
14
+ The first command previews the changes. The second opens guided setup. Setup shows computer and project changes in separate groups and asks for approval before it applies each group. A fresh setup selects designs, plans, product requirements (PRDs), and work backlogs. It selects no optional Skills unless you choose them.
14
15
 
15
- ```bash
16
- npx @brucewaynedecoy/make-docs@next setup --yes
17
- ```
18
-
19
- The installer writes a profile-aware documentation system and records managed files in `.make-docs/manifest.json` so later runs can update generated files without overwriting local edits.
20
-
21
- ## Common Commands
22
-
23
- ```bash
24
- # Install the default documentation system
25
- npx @brucewaynedecoy/make-docs@next setup --yes
16
+ You can also run `npx @brucewaynedecoy/make-docs@latest` without a command. In a project with no Make Docs install, it starts guided setup. In a project with an install, it shows status and help without changing files. Run `setup` to sync saved choices.
26
17
 
27
- # Preview changes without writing files
28
- npx @brucewaynedecoy/make-docs@next setup --dry-run
18
+ ## Main Commands
29
19
 
30
- # Reconfigure an existing installation
31
- npx @brucewaynedecoy/make-docs@next setup reconfigure
20
+ Run `npx @brucewaynedecoy/make-docs@latest <command> --help` for options.
32
21
 
33
- # Back up a managed installation
34
- npx @brucewaynedecoy/make-docs@next setup backup
22
+ | Command | Use |
23
+ | --- | --- |
24
+ | `setup` | Install, sync, reconfigure, manage Skills, back up, or remove project assets. |
25
+ | `project` | Inspect and manage project settings and surfaces. |
26
+ | `resource` | List, read, or ensure system resources. |
27
+ | `run` | Run available project and workflow operations. |
28
+ | `mcp` | Start the MCP server for agent tools. |
29
+ | `update` | Update a persistent tool install. |
30
+ | `uninstall` | Remove the machine-level tool install. |
35
31
 
36
- # Remove this project's managed make-docs files while preserving unmanaged files
37
- npx @brucewaynedecoy/make-docs@next setup remove
32
+ The npm package exposes the `make-docs` executable. If you install it globally, you can use `make-docs` in place of the `npx` command. The MCP server and CLI use the same operation core. MCP writes require an explicit write setting and follow the CLI's dry-run and approval rules.
38
33
 
39
- # Manage installable skill packs
40
- npx @brucewaynedecoy/make-docs@next setup skills
34
+ ## What Setup Adds
41
35
 
42
- # Run deterministic registry operations
43
- npx @brucewaynedecoy/make-docs@next run playbook catalog
36
+ Setup creates instruction routes and document areas under `docs/designs/`, `docs/plans/`, `docs/prd/`, and `docs/work/`. It creates project or audience assets only when needed. The installed CLI can serve system resources without copying them into the project; local copies are optional.
44
37
 
45
- # Run the MCP stdio server
46
- npx @brucewaynedecoy/make-docs@next mcp
47
- ```
38
+ The global Make Docs Store holds managed install and recovery records. The project can keep its identity and choices in `.make-docs/config.yaml`. Managed writes stop if the Store cannot record them. Ordinary document work can continue without the CLI or Store.
48
39
 
49
- Use the scoped npm package name for package-runner lookup and installation. The executable exposed by that package is `make-docs`; install, maintenance, deterministic operation, and MCP behavior all live in the TypeScript package.
40
+ ## Optional Skills
50
41
 
51
- The current npm package ships a read-first MCP stdio surface through `make-docs mcp`. The shipped MCP tools inspect installed state, read manifest/config state, classify compatibility, build dry-run plans, and delegate deterministic operations to the same operation registry and core used by `make-docs run`. Mutation-oriented MCP behavior remains gated by explicit approval or outside the first shipped surface.
42
+ The package includes eight first-party Skills: `archive-docs`, `backlog-review`, `cleanup-docs`, `decompose-codebase`, `factory`, `human-experience`, `naive-uat`, and `preflight`. A fresh setup installs none of them. Use `make-docs setup skills` to select or manage Skills. The built-in Skills need no separate source download.
52
43
 
53
44
  ## Package Contents
54
45
 
55
- All eight optional first-party Skills are embedded in the compiled `dist/` output. Selecting a first-party Skill needs no network fetch or source checkout. A missing or corrupt embedded payload stops safely; it does not fall back to a remote copy. `backlog-review` adds the guided full-portfolio review. `preflight`, `factory`, and `human-experience` activate only on explicit request. `naive-uat` keeps the Unassisted Goal Testing workflow and CLI interface.
56
-
57
- The published npm tarball contains npm metadata and license files, this README, built CLI output under `dist/`, the bundled `template/`, `skill-registry.json`, and `skill-registry.schema.json`. Repo-root `docs/`, root `AGENTS.md`, root `CLAUDE.md`, source workspaces, scripts, and scratch planning material are not shipped as tarball-root package contents.
58
-
59
- ## What Gets Installed
60
-
61
- The selected setup manages root and lifecycle instruction routers for `docs/designs/`, `docs/plans/`, `docs/prd/`, and `docs/work/`. System resources resolve through the installed CLI; local `.make-docs/system/` bodies are optional selected projections.
62
-
63
- Project assets are created on demand under `docs/assets/project/` or `docs/assets/<persona>/`. The default audiences are `user` and `maintainer`. Archive and history content lives under `.make-docs/archive/`. Empty asset children are not scaffolded.
64
-
65
- Selected Skills use standard agent locations. Project Claude-only installs directly under `.claude/skills/<name>`; Codex-only installs directly under `.agents/skills/<name>`; both use `.agents/skills` plus Claude links or supported native copies. Global scope uses `~/.agents/skills` plus selected harness access. Do not create unselected project Skill roots or an active `.make-docs/agentics` layer. Skills are optional: bare setup and `--selected-skills none` install no Skill files. `--selected-skills all` selects the effective registry. Existing unmanaged copies need the reviewed `setup skills --adopt-existing` path before the CLI may own them.
66
-
67
- The global Make Docs Store owns installation, upgrade, backup metadata, migration, and recovery state. `.make-docs/config.yaml` may retain project identity and configuration. Local backup payload copies may live under `.make-docs/backup/`; they do not replace Store records. Required recording failure stops a managed write safely. Ordinary document work can continue without the CLI or optional lifecycle capture.
68
-
69
- Clean managed files can update in place. Local edits and unmanaged conflicts remain protected. Review the CLI's conflict and recovery output before an affected apply.
70
-
71
- ## Capability Profile
72
-
73
- The default install includes `designs`, `plans`, `prd`, and `work`. You can opt out of capability families during the interactive wizard or with flags:
74
-
75
- ```bash
76
- npx @brucewaynedecoy/make-docs@next setup --yes --no-work
77
- npx @brucewaynedecoy/make-docs@next setup --yes --no-prd
78
- npx @brucewaynedecoy/make-docs@next setup --yes --no-plans
79
- npx @brucewaynedecoy/make-docs@next setup --yes --no-designs
80
- ```
81
-
82
- The capability graph is dependency-aware:
83
-
84
- - `designs` is independent
85
- - `plans` is independent
86
- - `prd` requires `plans`
87
- - `work` requires both `plans` and `prd`
88
-
89
- If you disable a prerequisite, downstream capabilities stay selected for later but are disabled until the prerequisite is enabled again.
90
-
91
- ## Requirements
92
-
93
- - Node.js 18 or newer
94
- - npm with `npx` / `npm exec`
46
+ The npm package contains this README, the license, the built CLI in `dist/`, the documentation template, and the Skill registry files. Repository plans, work records, source workspaces, and local project assets are not part of the published package.
95
47
 
96
- ## Repository
48
+ ## More Help
97
49
 
98
- Source, issues, and maintainer documentation live at [github.com/brucewaynedecoy/make-docs](https://github.com/brucewaynedecoy/make-docs).
50
+ - [Installing Make Docs](https://github.com/brucewaynedecoy/make-docs/blob/main/docs/assets/user/getting-started-installing-make-docs.md)
51
+ - [Managing Installations](https://github.com/brucewaynedecoy/make-docs/blob/main/docs/assets/user/cli-lifecycle-managing-installations.md)
52
+ - [Installing and Managing Skills](https://github.com/brucewaynedecoy/make-docs/blob/main/docs/assets/user/skills-installing-and-managing-skills.md)
53
+ - [Source code and issues](https://github.com/brucewaynedecoy/make-docs)
99
54
 
100
55
  ## License
101
56
 
102
- MIT. See [LICENSE](LICENSE).
57
+ MIT
@@ -5,10 +5,10 @@ import {
5
5
  prepareBackupExecution,
6
6
  resolveBackupDestinationPlan,
7
7
  runBackupCommand
8
- } from "./chunk-GNP6HRVP.js";
9
- import "./chunk-G5EF63GG.js";
10
- import "./chunk-Z5K4FHYP.js";
11
- import "./chunk-MXBHCHSM.js";
8
+ } from "./chunk-LV3CBXZB.js";
9
+ import "./chunk-GERMRLJ2.js";
10
+ import "./chunk-3EXHM5L2.js";
11
+ import "./chunk-YVSASZMT.js";
12
12
  import "./chunk-D4HDZEJT.js";
13
13
  export {
14
14
  compareBackupRelativePathDepth,
@@ -17,4 +17,4 @@ export {
17
17
  resolveBackupDestinationPlan,
18
18
  runBackupCommand
19
19
  };
20
- //# sourceMappingURL=backup-73HQNKMC.js.map
20
+ //# sourceMappingURL=backup-CM7RL2Q7.js.map