create-quiver 0.15.0 → 0.15.1
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/CHANGELOG.md +6 -0
- package/README.md +31 -0
- package/README_FOR_AI.md +8 -3
- package/ROADMAP.md +5 -0
- package/docs/AI_CONTEXT.md.template +4 -0
- package/docs/AI_ONBOARDING_PROMPT.md.template +8 -0
- package/docs/CLI_UX_GUIDE.md +16 -1
- package/docs/COMMANDS.md.template +14 -4
- package/docs/TROUBLESHOOTING.md +70 -0
- package/docs/TROUBLESHOOTING.md.template +20 -0
- package/docs/getting-started/installation.md +86 -0
- package/docs/reference/commands.md +29 -1
- package/package.json +1 -1
- package/specs/quiver-v31-ai-model-catalog-agent-selection/EVIDENCE_REPORT.md +185 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/EXECUTION_PLAN.md +85 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/SPEC.md +337 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/STATUS.md +30 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/pr.md +98 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-00-spec-foundation/CLOSURE_BRIEF.md +30 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-00-spec-foundation/EXECUTION_BRIEF.md +51 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-00-spec-foundation/slice.json +62 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-01-model-catalog-alias-normalization/CLOSURE_BRIEF.md +32 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-01-model-catalog-alias-normalization/EXECUTION_BRIEF.md +53 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-01-model-catalog-alias-normalization/slice.json +72 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-02-interactive-agent-set-selectors/CLOSURE_BRIEF.md +36 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-02-interactive-agent-set-selectors/EXECUTION_BRIEF.md +56 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-02-interactive-agent-set-selectors/slice.json +78 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-03-agent-doctor-repair/CLOSURE_BRIEF.md +36 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-03-agent-doctor-repair/EXECUTION_BRIEF.md +57 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-03-agent-doctor-repair/slice.json +77 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-04-shared-preflight-provider-errors/CLOSURE_BRIEF.md +35 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-04-shared-preflight-provider-errors/EXECUTION_BRIEF.md +55 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-04-shared-preflight-provider-errors/slice.json +84 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-05-ai-models-list/CLOSURE_BRIEF.md +32 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-05-ai-models-list/EXECUTION_BRIEF.md +52 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-05-ai-models-list/slice.json +72 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-06-docs-templates-alignment/CLOSURE_BRIEF.md +33 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-06-docs-templates-alignment/EXECUTION_BRIEF.md +58 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-06-docs-templates-alignment/slice.json +84 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-07-tests-smokes-release-readiness/CLOSURE_BRIEF.md +32 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-07-tests-smokes-release-readiness/EXECUTION_BRIEF.md +59 -0
- package/specs/quiver-v31-ai-model-catalog-agent-selection/slices/slice-07-tests-smokes-release-readiness/slice.json +94 -0
- package/specs/quiver-v32-npx-installation-guidance/EVIDENCE_REPORT.md +26 -0
- package/specs/quiver-v32-npx-installation-guidance/SPEC.md +55 -0
- package/specs/quiver-v32-npx-installation-guidance/STATUS.md +23 -0
- package/specs/quiver-v32-npx-installation-guidance/pr.md +72 -0
- package/specs/quiver-v32-npx-installation-guidance/slices/slice-00-installation-docs/CLOSURE_BRIEF.md +31 -0
- package/specs/quiver-v32-npx-installation-guidance/slices/slice-00-installation-docs/EXECUTION_BRIEF.md +56 -0
- package/specs/quiver-v32-npx-installation-guidance/slices/slice-00-installation-docs/slice.json +75 -0
- package/src/create-quiver/commands/ai.js +449 -34
- package/src/create-quiver/commands/flow.js +2 -2
- package/src/create-quiver/index.js +26 -10
- package/src/create-quiver/lib/agent-profiles.js +332 -4
- package/src/create-quiver/lib/ai/execution-plan.js +7 -2
- package/src/create-quiver/lib/ai/executor.js +9 -2
- package/src/create-quiver/lib/ai/model-catalog.js +333 -0
- package/src/create-quiver/lib/ai/providers.js +143 -4
- package/src/create-quiver/lib/cli/selectors.js +53 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# EXECUTION_BRIEF - slice-07 Tests, smokes, package dry-run, and release readiness
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
The v31 changes touch core AI command behavior and agent profile setup. Release readiness must prove backward compatibility, no-TTY safety, JSON cleanliness, and package safety.
|
|
6
|
+
|
|
7
|
+
## Objective
|
|
8
|
+
|
|
9
|
+
Close v31 with full validation, evidence, and release readiness without publishing npm.
|
|
10
|
+
|
|
11
|
+
## Scope
|
|
12
|
+
|
|
13
|
+
- tests and smoke suites
|
|
14
|
+
- final docs/evidence updates
|
|
15
|
+
- `CHANGELOG.md`
|
|
16
|
+
- `README_FOR_AI.md`
|
|
17
|
+
- `ROADMAP.md`
|
|
18
|
+
- v31 spec closure files
|
|
19
|
+
|
|
20
|
+
## Acceptance Criteria
|
|
21
|
+
|
|
22
|
+
- Full test suite passes.
|
|
23
|
+
- Smoke suites pass.
|
|
24
|
+
- Package smoke and npm pack dry-run pass.
|
|
25
|
+
- Spec validation passes.
|
|
26
|
+
- Final evidence is recorded.
|
|
27
|
+
- Known remaining risks are documented.
|
|
28
|
+
|
|
29
|
+
## Technical Plan Summary
|
|
30
|
+
|
|
31
|
+
Run final validation after every implementation and docs slice, then update status/evidence/PR body/closure briefs.
|
|
32
|
+
|
|
33
|
+
## Suggested Steps
|
|
34
|
+
|
|
35
|
+
1. Run focused tests from prior slices if needed.
|
|
36
|
+
2. Run full suite.
|
|
37
|
+
3. Run smoke suites.
|
|
38
|
+
4. Run package safety and npm pack dry-run.
|
|
39
|
+
5. Validate spec.
|
|
40
|
+
6. Update final evidence and status.
|
|
41
|
+
|
|
42
|
+
## Restrictions
|
|
43
|
+
|
|
44
|
+
- Do not publish npm.
|
|
45
|
+
- Do not skip failed tests.
|
|
46
|
+
- Do not add new product scope.
|
|
47
|
+
|
|
48
|
+
## Risks
|
|
49
|
+
|
|
50
|
+
- Live provider validation depends on local provider auth and should be documented separately.
|
|
51
|
+
- Catalog staleness remains a known operational risk.
|
|
52
|
+
|
|
53
|
+
## Completion Checklist
|
|
54
|
+
|
|
55
|
+
- [ ] Full tests pass.
|
|
56
|
+
- [ ] Smokes pass.
|
|
57
|
+
- [ ] Package dry-run passes.
|
|
58
|
+
- [ ] Evidence report completed.
|
|
59
|
+
- [ ] PR body updated.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-07-tests-smokes-release-readiness",
|
|
3
|
+
"ticket": "QUIVER-31-07",
|
|
4
|
+
"type": "release",
|
|
5
|
+
"title": "Tests, smokes, package dry-run, and release readiness",
|
|
6
|
+
"objective": "Close the v31 spec with comprehensive validation, evidence, and package readiness.",
|
|
7
|
+
"description": "Runs full tests, smoke suites, package safety, npm pack dry-run, spec validation, and final docs/evidence closure.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "feature",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "v31-tests-smokes-release-readiness",
|
|
12
|
+
"branch_name": "feature/QUIVER-31-07-v31-tests-smokes-release-readiness"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"CHANGELOG.md",
|
|
16
|
+
"README_FOR_AI.md",
|
|
17
|
+
"ROADMAP.md",
|
|
18
|
+
"src/create-quiver/index.js",
|
|
19
|
+
"src/create-quiver/commands/ai.js",
|
|
20
|
+
"src/create-quiver/commands/flow.js",
|
|
21
|
+
"tests/**",
|
|
22
|
+
"scripts/ci/**",
|
|
23
|
+
"specs/quiver-v31-ai-model-catalog-agent-selection/**"
|
|
24
|
+
],
|
|
25
|
+
"expected_read_paths": [
|
|
26
|
+
"SPEC.md",
|
|
27
|
+
"README_FOR_AI.md",
|
|
28
|
+
"CHANGELOG.md",
|
|
29
|
+
"ROADMAP.md",
|
|
30
|
+
"scripts/release-quiver.sh",
|
|
31
|
+
"scripts/package-quiver.sh",
|
|
32
|
+
"tests/**"
|
|
33
|
+
],
|
|
34
|
+
"allowed_write_paths": [
|
|
35
|
+
"CHANGELOG.md",
|
|
36
|
+
"README_FOR_AI.md",
|
|
37
|
+
"ROADMAP.md",
|
|
38
|
+
"src/create-quiver/index.js",
|
|
39
|
+
"src/create-quiver/commands/ai.js",
|
|
40
|
+
"src/create-quiver/commands/flow.js",
|
|
41
|
+
"tests/**",
|
|
42
|
+
"scripts/ci/**",
|
|
43
|
+
"specs/quiver-v31-ai-model-catalog-agent-selection/**"
|
|
44
|
+
],
|
|
45
|
+
"depends_on": [
|
|
46
|
+
"slice-02-interactive-agent-set-selectors",
|
|
47
|
+
"slice-03-agent-doctor-repair",
|
|
48
|
+
"slice-04-shared-preflight-provider-errors",
|
|
49
|
+
"slice-05-ai-models-list",
|
|
50
|
+
"slice-06-docs-templates-alignment"
|
|
51
|
+
],
|
|
52
|
+
"parallel_safe": "no",
|
|
53
|
+
"parallel_safe_reason": "Final release validation depends on every implementation and docs slice.",
|
|
54
|
+
"must": [
|
|
55
|
+
"Run full test suite.",
|
|
56
|
+
"Run smoke suites.",
|
|
57
|
+
"Run package safety and npm pack dry-run.",
|
|
58
|
+
"Validate spec.",
|
|
59
|
+
"Update evidence report, status, closure briefs, and PR body.",
|
|
60
|
+
"Do not publish npm without explicit release approval."
|
|
61
|
+
],
|
|
62
|
+
"not_included": [
|
|
63
|
+
"Publishing npm.",
|
|
64
|
+
"Skipping failed tests.",
|
|
65
|
+
"Adding new product scope."
|
|
66
|
+
],
|
|
67
|
+
"acceptance": [
|
|
68
|
+
"Full suite passes.",
|
|
69
|
+
"Smoke suites pass.",
|
|
70
|
+
"Package smoke and npm pack dry-run pass.",
|
|
71
|
+
"Spec validation passes.",
|
|
72
|
+
"Final evidence is recorded.",
|
|
73
|
+
"Known remaining risks are documented."
|
|
74
|
+
],
|
|
75
|
+
"tests": [
|
|
76
|
+
"node --test tests/**/*.test.js",
|
|
77
|
+
"npm run smoke:create-quiver",
|
|
78
|
+
"npm run smoke:doctor-fixtures",
|
|
79
|
+
"npm run smoke:guided-workflow",
|
|
80
|
+
"npm run package:quiver",
|
|
81
|
+
"npm pack --dry-run",
|
|
82
|
+
"git diff --check",
|
|
83
|
+
"node bin/create-quiver.js spec validate specs/quiver-v31-ai-model-catalog-agent-selection"
|
|
84
|
+
],
|
|
85
|
+
"validation_hints": [
|
|
86
|
+
"Include legacy bad-profile fixture coverage.",
|
|
87
|
+
"Document any live provider smoke separately from automated tests."
|
|
88
|
+
],
|
|
89
|
+
"estimated_hours": 6,
|
|
90
|
+
"status": "completed",
|
|
91
|
+
"blocked_reason": null,
|
|
92
|
+
"actual_hours": 5,
|
|
93
|
+
"completed_at": "2026-05-27"
|
|
94
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Evidence Report - Quiver v32 npx Installation Guidance
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
Documentation-only change. No product code was modified.
|
|
6
|
+
|
|
7
|
+
## Evidence
|
|
8
|
+
|
|
9
|
+
| Command | Status | Notes |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| `git diff --check` | Passed | No whitespace errors. |
|
|
12
|
+
| `node bin/create-quiver.js spec validate specs/quiver-v32-npx-installation-guidance` | Passed | Spec package validated with one completed slice. |
|
|
13
|
+
|
|
14
|
+
## Slice Evidence
|
|
15
|
+
|
|
16
|
+
| Slice | Status | Evidence |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| `slice-00-installation-docs` | Completed | README, installation guide, troubleshooting, templates, command reference, source-of-truth docs, and PR body updated. |
|
|
19
|
+
|
|
20
|
+
## Manual Review
|
|
21
|
+
|
|
22
|
+
- README now explains `npx` vs local installation.
|
|
23
|
+
- A dedicated installation guide explains when `node_modules` is expected.
|
|
24
|
+
- Troubleshooting includes the `node_modules` confusion case.
|
|
25
|
+
- Generated documentation templates include the same guidance.
|
|
26
|
+
- `README_FOR_AI.md` is synchronized.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Quiver v32 - npx Installation Guidance
|
|
2
|
+
|
|
3
|
+
## Objective
|
|
4
|
+
|
|
5
|
+
Clarify the expected installation behavior of Quiver when users run it with `npx`, especially why it does not appear in project `node_modules` unless installed explicitly as a development dependency.
|
|
6
|
+
|
|
7
|
+
## Problem
|
|
8
|
+
|
|
9
|
+
Users can run:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx --yes create-quiver@latest ...
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
and expect the package to appear in `node_modules`. That is not how `npx` works, but the repository documentation did not explain the distinction clearly enough.
|
|
16
|
+
|
|
17
|
+
## Scope
|
|
18
|
+
|
|
19
|
+
- Add concise public-facing guidance to `README.md`.
|
|
20
|
+
- Add a deeper installation guide under `docs/getting-started/`.
|
|
21
|
+
- Add troubleshooting guidance for the common `node_modules` confusion.
|
|
22
|
+
- Update generated-project troubleshooting and command templates.
|
|
23
|
+
- Keep `README_FOR_AI.md` synchronized as the AI source of truth.
|
|
24
|
+
|
|
25
|
+
## Non-Scope
|
|
26
|
+
|
|
27
|
+
- No product code changes.
|
|
28
|
+
- No npm publication.
|
|
29
|
+
- No changes to package installation behavior.
|
|
30
|
+
- No automatic local install changes.
|
|
31
|
+
|
|
32
|
+
## Acceptance Criteria
|
|
33
|
+
|
|
34
|
+
- Given a user runs Quiver with `npx --yes create-quiver@latest`, when they read the README, then they understand why Quiver may not appear in `node_modules`.
|
|
35
|
+
- Given a team wants a pinned Quiver version, when they read the installation guide, then they can install `create-quiver` as a `devDependency`.
|
|
36
|
+
- Given a user searches troubleshooting, when they see the `node_modules` entry, then they get the expected behavior, recovery path, and relevant links.
|
|
37
|
+
- Given generated project docs are created from templates, when troubleshooting and command docs are inspected, then the same `npx` vs local install contract is represented.
|
|
38
|
+
- Given an AI agent uses `README_FOR_AI.md`, when it explains installation, then it does not recommend global install and correctly distinguishes `npx` from local devDependency usage.
|
|
39
|
+
|
|
40
|
+
## Files
|
|
41
|
+
|
|
42
|
+
- `README.md`
|
|
43
|
+
- `README_FOR_AI.md`
|
|
44
|
+
- `docs/getting-started/installation.md`
|
|
45
|
+
- `docs/reference/commands.md`
|
|
46
|
+
- `docs/TROUBLESHOOTING.md`
|
|
47
|
+
- `docs/TROUBLESHOOTING.md.template`
|
|
48
|
+
- `docs/COMMANDS.md.template`
|
|
49
|
+
- `specs/quiver-v32-npx-installation-guidance/**`
|
|
50
|
+
|
|
51
|
+
## Validation
|
|
52
|
+
|
|
53
|
+
- `git diff --check`
|
|
54
|
+
- `node bin/create-quiver.js spec validate specs/quiver-v32-npx-installation-guidance`
|
|
55
|
+
- Documentation review for link consistency and scope.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Status - Quiver v32 npx Installation Guidance
|
|
2
|
+
|
|
3
|
+
**Overall status:** Completed, pending PR
|
|
4
|
+
**Created:** 2026-05-27
|
|
5
|
+
**Current slice:** slice-00 completed
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
This documentation-only spec clarifies that `npx --yes create-quiver@latest` runs Quiver from npm's execution cache and does not install it into project `node_modules`. It documents when teams should install `create-quiver` as a local `devDependency`.
|
|
10
|
+
|
|
11
|
+
## Slice Status
|
|
12
|
+
|
|
13
|
+
| Slice | Status | Notes |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| slice-00-installation-docs | Completed | README, installation guide, troubleshooting, templates, command reference, source-of-truth docs, and PR body updated. |
|
|
16
|
+
|
|
17
|
+
## Current Blockers
|
|
18
|
+
|
|
19
|
+
- None.
|
|
20
|
+
|
|
21
|
+
## Next Step
|
|
22
|
+
|
|
23
|
+
Open the documentation PR.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
## Title
|
|
2
|
+
|
|
3
|
+
Quiver v32: clarify npx vs local installation
|
|
4
|
+
|
|
5
|
+
## Summary
|
|
6
|
+
|
|
7
|
+
- Explains why `npx --yes create-quiver@latest` does not install Quiver into project `node_modules`.
|
|
8
|
+
- Adds a dedicated installation guide for `npx` vs local `devDependency` usage.
|
|
9
|
+
- Adds troubleshooting guidance for users who expect Quiver in `node_modules`.
|
|
10
|
+
- Aligns generated docs templates and `README_FOR_AI.md`.
|
|
11
|
+
|
|
12
|
+
## Scope
|
|
13
|
+
|
|
14
|
+
- Public README guidance.
|
|
15
|
+
- Installation guide under `docs/getting-started/`.
|
|
16
|
+
- Troubleshooting entry.
|
|
17
|
+
- Command reference and generated docs template notes.
|
|
18
|
+
- Documentation-only WDD/SDD traceability.
|
|
19
|
+
|
|
20
|
+
## Files
|
|
21
|
+
|
|
22
|
+
- `README.md`
|
|
23
|
+
- `README_FOR_AI.md`
|
|
24
|
+
- `docs/getting-started/installation.md`
|
|
25
|
+
- `docs/reference/commands.md`
|
|
26
|
+
- `docs/TROUBLESHOOTING.md`
|
|
27
|
+
- `docs/TROUBLESHOOTING.md.template`
|
|
28
|
+
- `docs/COMMANDS.md.template`
|
|
29
|
+
- `specs/quiver-v32-npx-installation-guidance/**`
|
|
30
|
+
|
|
31
|
+
## How to Test (DETAILED - REQUIRED)
|
|
32
|
+
|
|
33
|
+
### Required Environment
|
|
34
|
+
|
|
35
|
+
- Node.js and npm.
|
|
36
|
+
- Local Quiver source checkout.
|
|
37
|
+
|
|
38
|
+
### Worktree Access
|
|
39
|
+
|
|
40
|
+
- Use a dedicated docs branch for this PR.
|
|
41
|
+
- No product-code changes are expected.
|
|
42
|
+
|
|
43
|
+
### Run the Project
|
|
44
|
+
|
|
45
|
+
This is a documentation-only change. No app runtime is needed.
|
|
46
|
+
|
|
47
|
+
### Use Cases
|
|
48
|
+
|
|
49
|
+
- Read the README and confirm it explains why `npx` does not populate `node_modules`.
|
|
50
|
+
- Read `docs/getting-started/installation.md` and confirm it explains when to use `npx` and when to install `create-quiver` as a `devDependency`.
|
|
51
|
+
- Read `docs/TROUBLESHOOTING.md` and confirm it covers the `node_modules` confusion.
|
|
52
|
+
- Inspect templates to confirm generated projects inherit the same explanation.
|
|
53
|
+
|
|
54
|
+
### Technical Verification
|
|
55
|
+
|
|
56
|
+
- `git diff --check`
|
|
57
|
+
- `node bin/create-quiver.js spec validate specs/quiver-v32-npx-installation-guidance`
|
|
58
|
+
|
|
59
|
+
## Evidence
|
|
60
|
+
|
|
61
|
+
- Documentation updated in public, reference, troubleshooting, template, and AI source-of-truth surfaces.
|
|
62
|
+
- `git diff --check` passed.
|
|
63
|
+
- `node bin/create-quiver.js spec validate specs/quiver-v32-npx-installation-guidance` passed.
|
|
64
|
+
|
|
65
|
+
## Rollback
|
|
66
|
+
|
|
67
|
+
Revert this documentation slice commit. No runtime behavior or package installation behavior changed.
|
|
68
|
+
|
|
69
|
+
## Risks / Notes
|
|
70
|
+
|
|
71
|
+
- This PR does not change how `init` or `migrate` may install local dev dependencies.
|
|
72
|
+
- The guidance intentionally keeps `npx --yes create-quiver@latest` as the recommended bootstrap path.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Closure Brief - slice-00-installation-docs
|
|
2
|
+
|
|
3
|
+
## Resumen de lo realizado
|
|
4
|
+
|
|
5
|
+
Se agregó documentación para explicar que `npx --yes create-quiver@latest` ejecuta Quiver desde la caché de npm y no instala el paquete dentro de `node_modules`. También se documentó cuándo conviene instalar `create-quiver` como `devDependency`.
|
|
6
|
+
|
|
7
|
+
## Validación contra criterios de aceptación
|
|
8
|
+
|
|
9
|
+
- README incluye explicación breve y link a la guía.
|
|
10
|
+
- `docs/getting-started/installation.md` explica `npx`, caché de npm, `node_modules` y `devDependency`.
|
|
11
|
+
- `docs/TROUBLESHOOTING.md` cubre la confusión de `node_modules`.
|
|
12
|
+
- Templates generados fueron alineados.
|
|
13
|
+
- `README_FOR_AI.md` fue actualizado como fuente de verdad.
|
|
14
|
+
|
|
15
|
+
## Cambios relevantes
|
|
16
|
+
|
|
17
|
+
- Public documentation now covers `npx` vs local install.
|
|
18
|
+
- Generated project templates inherit the key guidance.
|
|
19
|
+
- Spec package and PR body were created for traceability.
|
|
20
|
+
|
|
21
|
+
## Pendientes
|
|
22
|
+
|
|
23
|
+
- Abrir el PR.
|
|
24
|
+
|
|
25
|
+
## Riesgos remanentes
|
|
26
|
+
|
|
27
|
+
- Ninguno crítico. Esta spec no cambia comportamiento de producto.
|
|
28
|
+
|
|
29
|
+
## Recomendaciones futuras
|
|
30
|
+
|
|
31
|
+
- Consider adding `npx` cache behavior to `create-quiver --help` only if more users hit the same confusion.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Execution Brief - slice-00-installation-docs
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
Users can run Quiver with `npx --yes create-quiver@latest` and expect the package to appear in project `node_modules`. The expected npm behavior is that `npx` runs the CLI from npm's execution cache unless the package is explicitly installed locally.
|
|
6
|
+
|
|
7
|
+
## Objective
|
|
8
|
+
|
|
9
|
+
Document the `npx` vs local installation behavior clearly across public docs, troubleshooting, templates, and AI source-of-truth guidance.
|
|
10
|
+
|
|
11
|
+
## Scope
|
|
12
|
+
|
|
13
|
+
- Root README summary.
|
|
14
|
+
- Dedicated installation guide.
|
|
15
|
+
- Troubleshooting entry.
|
|
16
|
+
- Command reference note.
|
|
17
|
+
- Generated docs template note.
|
|
18
|
+
- `README_FOR_AI.md` synchronization.
|
|
19
|
+
|
|
20
|
+
## Criterios de aceptación
|
|
21
|
+
|
|
22
|
+
- README includes a concise explanation of why Quiver may not appear in `node_modules`.
|
|
23
|
+
- Installation guide explains `npx`, npm cache execution, and `devDependency` installation.
|
|
24
|
+
- Troubleshooting covers the user confusion as a recoverable expected behavior.
|
|
25
|
+
- Templates include the same guidance for generated projects.
|
|
26
|
+
- No product code is modified.
|
|
27
|
+
|
|
28
|
+
## Plan técnico resumido
|
|
29
|
+
|
|
30
|
+
1. Add the public README section and link.
|
|
31
|
+
2. Add `docs/getting-started/installation.md`.
|
|
32
|
+
3. Add `docs/TROUBLESHOOTING.md`.
|
|
33
|
+
4. Update generated troubleshooting and command templates.
|
|
34
|
+
5. Update `README_FOR_AI.md`.
|
|
35
|
+
6. Validate docs and spec package.
|
|
36
|
+
|
|
37
|
+
## Restricciones
|
|
38
|
+
|
|
39
|
+
- Do not recommend global installation.
|
|
40
|
+
- Do not change runtime behavior.
|
|
41
|
+
- Do not change npm package metadata.
|
|
42
|
+
|
|
43
|
+
## Riesgos
|
|
44
|
+
|
|
45
|
+
- Duplicating too much setup guidance in the root README.
|
|
46
|
+
- Confusing `npx create-quiver` local resolution with `npx --yes create-quiver@latest` latest resolution.
|
|
47
|
+
|
|
48
|
+
## Checklist de finalización
|
|
49
|
+
|
|
50
|
+
- [x] README updated.
|
|
51
|
+
- [x] Installation guide added.
|
|
52
|
+
- [x] Troubleshooting added.
|
|
53
|
+
- [x] Templates updated.
|
|
54
|
+
- [x] `README_FOR_AI.md` updated.
|
|
55
|
+
- [x] Validation commands run.
|
|
56
|
+
- [ ] PR opened.
|
package/specs/quiver-v32-npx-installation-guidance/slices/slice-00-installation-docs/slice.json
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-00-installation-docs",
|
|
3
|
+
"ticket": "QUIVER-32-00",
|
|
4
|
+
"type": "documentation",
|
|
5
|
+
"title": "npx and node_modules installation guidance",
|
|
6
|
+
"objective": "Document why Quiver does not appear in project node_modules when executed with npx, and when local devDependency installation is appropriate.",
|
|
7
|
+
"description": "Adds public README guidance, a dedicated installation guide, troubleshooting coverage, generated docs template notes, and AI source-of-truth synchronization.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "feature",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "v32-npx-installation-guidance",
|
|
12
|
+
"branch_name": "docs/npx-node-modules-guidance"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"README.md",
|
|
16
|
+
"README_FOR_AI.md",
|
|
17
|
+
"docs/getting-started/installation.md",
|
|
18
|
+
"docs/reference/commands.md",
|
|
19
|
+
"docs/TROUBLESHOOTING.md",
|
|
20
|
+
"docs/TROUBLESHOOTING.md.template",
|
|
21
|
+
"docs/COMMANDS.md.template"
|
|
22
|
+
],
|
|
23
|
+
"expected_read_paths": [
|
|
24
|
+
"README_FOR_AI.md",
|
|
25
|
+
"README.md",
|
|
26
|
+
"docs/reference/commands.md",
|
|
27
|
+
"docs/TROUBLESHOOTING.md.template",
|
|
28
|
+
"docs/COMMANDS.md.template"
|
|
29
|
+
],
|
|
30
|
+
"allowed_write_paths": [
|
|
31
|
+
"README.md",
|
|
32
|
+
"README_FOR_AI.md",
|
|
33
|
+
"docs/getting-started/installation.md",
|
|
34
|
+
"docs/reference/commands.md",
|
|
35
|
+
"docs/TROUBLESHOOTING.md",
|
|
36
|
+
"docs/TROUBLESHOOTING.md.template",
|
|
37
|
+
"docs/COMMANDS.md.template",
|
|
38
|
+
"specs/quiver-v32-npx-installation-guidance/**"
|
|
39
|
+
],
|
|
40
|
+
"depends_on": [],
|
|
41
|
+
"parallel_safe": "yes",
|
|
42
|
+
"parallel_safe_reason": "This is the only documentation slice in the spec.",
|
|
43
|
+
"must": [
|
|
44
|
+
"Explain that npx executes Quiver from npm's execution cache.",
|
|
45
|
+
"Explain why node_modules is not populated by npx usage.",
|
|
46
|
+
"Explain when to install create-quiver as a devDependency.",
|
|
47
|
+
"Keep README_FOR_AI synchronized.",
|
|
48
|
+
"Avoid claiming runtime behavior changes."
|
|
49
|
+
],
|
|
50
|
+
"not_included": [
|
|
51
|
+
"Product code changes.",
|
|
52
|
+
"Package publishing.",
|
|
53
|
+
"Global install guidance."
|
|
54
|
+
],
|
|
55
|
+
"acceptance": [
|
|
56
|
+
"README includes concise npx vs local install guidance.",
|
|
57
|
+
"A dedicated installation guide explains node_modules expectations.",
|
|
58
|
+
"Troubleshooting covers the missing node_modules symptom.",
|
|
59
|
+
"Generated docs templates include the same contract.",
|
|
60
|
+
"README_FOR_AI contains the source-of-truth explanation."
|
|
61
|
+
],
|
|
62
|
+
"tests": [
|
|
63
|
+
"git diff --check",
|
|
64
|
+
"node bin/create-quiver.js spec validate specs/quiver-v32-npx-installation-guidance"
|
|
65
|
+
],
|
|
66
|
+
"validation_hints": [
|
|
67
|
+
"Keep the docs concise and avoid duplicating long workflows in the root README.",
|
|
68
|
+
"Do not recommend global installation."
|
|
69
|
+
],
|
|
70
|
+
"estimated_hours": 1,
|
|
71
|
+
"status": "completed",
|
|
72
|
+
"blocked_reason": null,
|
|
73
|
+
"actual_hours": 1,
|
|
74
|
+
"completed_at": "2026-05-27"
|
|
75
|
+
}
|