create-quiver 0.4.0 → 0.6.0
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 +76 -22
- package/README_FOR_AI.md +30 -10
- package/docs/AI_CONTEXT.md.template +59 -0
- package/docs/AI_ONBOARDING_PROMPT.md.template +56 -0
- package/docs/CONTEXTO.md.template +1 -1
- package/docs/DOCUMENTATION_GUIDE.md.template +9 -7
- package/docs/INDEX.md.template +4 -0
- package/docs/WORKFLOW.md.template +7 -1
- package/package.json +2 -1
- package/package.template.json +2 -1
- package/scripts/init-docs.sh +209 -35
- package/scripts/package-quiver.sh +2 -0
- package/specs/quiver-v07-ai-context-pack/EVIDENCE_REPORT.md +24 -0
- package/specs/quiver-v07-ai-context-pack/SPEC.md +40 -0
- package/specs/quiver-v07-ai-context-pack/STATUS.md +24 -0
- package/specs/quiver-v07-ai-context-pack/slices/slice-01-ai-context-pack/slice.json +79 -0
- package/specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md +49 -0
- package/specs/quiver-v08-agent-onboarding-analysis/SPEC.md +53 -0
- package/specs/quiver-v08-agent-onboarding-analysis/STATUS.md +26 -0
- package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-01-project-scan-command/slice.json +73 -0
- package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-02-ai-onboarding-prompt/slice.json +82 -0
- package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-03-doctor-readme-adoption-flow/slice.json +76 -0
- package/specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md +33 -0
- package/specs/quiver-v09-onboarding-readme-flow/SPEC.md +44 -0
- package/specs/quiver-v09-onboarding-readme-flow/STATUS.md +25 -0
- package/specs/quiver-v09-onboarding-readme-flow/slices/slice-01-developer-readme-onboarding-flow/slice.json +69 -0
- package/specs/quiver-v09-onboarding-readme-flow/slices/slice-02-ai-handoff-doctor-guidance/slice.json +71 -0
- package/specs/quiver-v10-local-project-installation-guidance/EVIDENCE_REPORT.md +25 -0
- package/specs/quiver-v10-local-project-installation-guidance/SPEC.md +42 -0
- package/specs/quiver-v10-local-project-installation-guidance/STATUS.md +24 -0
- package/specs/quiver-v10-local-project-installation-guidance/slices/slice-01-local-project-installation-guidance/slice.json +75 -0
- package/specs/quiver-v11-existing-project-migration/EVIDENCE_REPORT.md +38 -0
- package/specs/quiver-v11-existing-project-migration/SPEC.md +59 -0
- package/specs/quiver-v11-existing-project-migration/STATUS.md +26 -0
- package/specs/quiver-v11-existing-project-migration/slices/slice-01-non-destructive-migrate-command/slice.json +73 -0
- package/specs/quiver-v11-existing-project-migration/slices/slice-02-version-metadata-doctor-upgrade-checks/slice.json +71 -0
- package/specs/quiver-v11-existing-project-migration/slices/slice-03-upgrade-docs-legacy-project-smokes/slice.json +78 -0
- package/src/create-quiver/index.js +757 -9
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Quiver v0.8 Spec Status
|
|
2
|
+
|
|
3
|
+
**Spec:** quiver-v08-agent-onboarding-analysis
|
|
4
|
+
**Last updated:** 2026-04-21
|
|
5
|
+
|
|
6
|
+
Slice numbering is local to this spec. The first slice is `slice-01`.
|
|
7
|
+
|
|
8
|
+
## Status
|
|
9
|
+
|
|
10
|
+
| Slice | Title | Status | PR | Estimated hours | Actual hours |
|
|
11
|
+
|-------|-------|--------|----|-----------------|--------------|
|
|
12
|
+
| slice-01 | Project Scan Command | Completed | - | 4 | 4 |
|
|
13
|
+
| slice-02 | AI Onboarding Prompt | Completed | - | 3 | 3 |
|
|
14
|
+
| slice-03 | Doctor and README Adoption Flow | Completed | - | 2 | 2 |
|
|
15
|
+
|
|
16
|
+
## Progress
|
|
17
|
+
|
|
18
|
+
- Completed slices: 3 / 3
|
|
19
|
+
- Estimated hours: 9
|
|
20
|
+
- Actual hours: 9
|
|
21
|
+
|
|
22
|
+
## Blockers
|
|
23
|
+
|
|
24
|
+
| Slice | Blocker | Since | Action needed |
|
|
25
|
+
|-------|---------|-------|---------------|
|
|
26
|
+
| - | - | - | - |
|
package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-01-project-scan-command/slice.json
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-01-project-scan-command",
|
|
3
|
+
"ticket": "QUIVER-01",
|
|
4
|
+
"type": "feature",
|
|
5
|
+
"title": "Project Scan Command",
|
|
6
|
+
"objective": "Add a deterministic `create-quiver analyze --dir <project>` command that scans an existing project and writes safe onboarding artifacts for humans and AI agents.",
|
|
7
|
+
"description": "Quiver currently initializes templates and validates them, but it does not inspect the target repository. This slice adds a local analyzer that detects project structure, package metadata, scripts, common frameworks, CI files, docs, and configuration signals without calling an AI provider or exposing secrets.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "feature",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "project-scan-command",
|
|
12
|
+
"branch_name": "feature/QUIVER-01-project-scan-command"
|
|
13
|
+
},
|
|
14
|
+
"must": [
|
|
15
|
+
"Add an `analyze` mode to the `create-quiver` CLI with `--dir <project>` support",
|
|
16
|
+
"Scan common project metadata files such as `package.json`, lockfiles, `pyproject.toml`, `go.mod`, `composer.json`, framework config files, README files, and GitHub workflows when present",
|
|
17
|
+
"Detect likely stack, package manager, scripts, test/build/dev commands, CI signals, documentation entry points, and top-level source directories",
|
|
18
|
+
"Write `docs/PROJECT_SCAN.json` with structured scan data and `docs/PROJECT_MAP.md` with a readable summary",
|
|
19
|
+
"Ignore heavy or generated folders including `.git`, `node_modules`, `dist`, `build`, `.next`, `coverage`, and vendor caches",
|
|
20
|
+
"Never read or serialize secret values from `.env`, `.env.*`, npm tokens, SSH keys, or private credential files"
|
|
21
|
+
],
|
|
22
|
+
"not_included": [
|
|
23
|
+
"Calling an AI model or generating natural-language conclusions beyond deterministic summaries",
|
|
24
|
+
"Editing product source code in the target project",
|
|
25
|
+
"Running install, build, test, or migration commands in the target project",
|
|
26
|
+
"Deep dependency vulnerability auditing",
|
|
27
|
+
"Windows-specific command copy UX beyond portable path generation"
|
|
28
|
+
],
|
|
29
|
+
"acceptance": [
|
|
30
|
+
"`npx create-quiver analyze --dir .` completes in a project that already has Quiver docs",
|
|
31
|
+
"The command creates or updates `docs/PROJECT_SCAN.json` and `docs/PROJECT_MAP.md`",
|
|
32
|
+
"The JSON artifact is valid JSON and has stable top-level keys for project, stack, commands, structure, ci, docs, risks, and skipped_paths",
|
|
33
|
+
"The markdown artifact is readable and includes detected commands without inventing missing scripts",
|
|
34
|
+
"The analyzer reports skipped secret files without printing their contents",
|
|
35
|
+
"Existing `init` and `doctor` modes continue to work"
|
|
36
|
+
],
|
|
37
|
+
"files": [
|
|
38
|
+
"src/create-quiver/index.js",
|
|
39
|
+
"scripts/ci/smoke-create-quiver.sh",
|
|
40
|
+
"scripts/package-quiver.sh",
|
|
41
|
+
"specs/quiver-v08-agent-onboarding-analysis/SPEC.md",
|
|
42
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
43
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md",
|
|
44
|
+
"specs/quiver-v08-agent-onboarding-analysis/slices/slice-01-project-scan-command/slice.json"
|
|
45
|
+
],
|
|
46
|
+
"tests": [
|
|
47
|
+
"node src/create-quiver/index.js analyze --dir <fixture>",
|
|
48
|
+
"node src/create-quiver/index.js doctor --dir <fixture>",
|
|
49
|
+
"bash scripts/ci/smoke-create-quiver.sh",
|
|
50
|
+
"bash scripts/package-quiver.sh",
|
|
51
|
+
"JSON parse check for generated `docs/PROJECT_SCAN.json`"
|
|
52
|
+
],
|
|
53
|
+
"documentation": [
|
|
54
|
+
"specs/quiver-v08-agent-onboarding-analysis/SPEC.md",
|
|
55
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
56
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md"
|
|
57
|
+
],
|
|
58
|
+
"dependencies": [
|
|
59
|
+
"quiver-v07-ai-context-pack"
|
|
60
|
+
],
|
|
61
|
+
"assumptions": [
|
|
62
|
+
"The analyzer should be deterministic and provider-neutral",
|
|
63
|
+
"The target project already has or can receive a `docs/` directory generated by Quiver",
|
|
64
|
+
"Project analysis should optimize for onboarding signal, not exhaustive static analysis"
|
|
65
|
+
],
|
|
66
|
+
"estimated_hours": 4,
|
|
67
|
+
"actual_hours": 0,
|
|
68
|
+
"status": "draft",
|
|
69
|
+
"blocked_reason": null,
|
|
70
|
+
"ready_at": null,
|
|
71
|
+
"started_at": null,
|
|
72
|
+
"completed_at": null
|
|
73
|
+
}
|
package/specs/quiver-v08-agent-onboarding-analysis/slices/slice-02-ai-onboarding-prompt/slice.json
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-02-ai-onboarding-prompt",
|
|
3
|
+
"ticket": "QUIVER-02",
|
|
4
|
+
"type": "docs",
|
|
5
|
+
"title": "AI Onboarding Prompt",
|
|
6
|
+
"objective": "Generate an exact provider-neutral prompt that instructs an AI agent how to use Quiver scan artifacts and complete project context docs safely.",
|
|
7
|
+
"description": "The README should not carry a long prompt, but every generated project should include a precise onboarding prompt that can be pasted into Codex, ChatGPT, Claude, or another agent. This slice adds that prompt as a generated artifact tied to the analysis output.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "docs",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "ai-onboarding-prompt",
|
|
12
|
+
"branch_name": "docs/QUIVER-02-ai-onboarding-prompt"
|
|
13
|
+
},
|
|
14
|
+
"must": [
|
|
15
|
+
"Add a generated `docs/AI_ONBOARDING_PROMPT.md` artifact or template",
|
|
16
|
+
"Make the prompt instruct the AI agent to read `docs/AI_CONTEXT.md`, `docs/PROJECT_SCAN.json`, `docs/PROJECT_MAP.md`, `docs/CONTEXTO.md`, `docs/WORKFLOW.md`, and the initial spec before editing",
|
|
17
|
+
"Constrain the prompt to documentation/context updates only unless the user explicitly authorizes product-code changes",
|
|
18
|
+
"Tell the AI agent not to read or expose secrets and to record uncertainty instead of inventing facts",
|
|
19
|
+
"Tell the AI agent to complete `docs/AI_CONTEXT.md`, `docs/CONTEXTO.md`, `docs/STATUS.md`, and the initial onboarding spec where applicable",
|
|
20
|
+
"Keep the root README concise and point to the generated prompt instead of embedding a long prompt inline"
|
|
21
|
+
],
|
|
22
|
+
"not_included": [
|
|
23
|
+
"Provider-specific prompt variants",
|
|
24
|
+
"Automatic prompt execution from the CLI",
|
|
25
|
+
"A chat UI or hosted onboarding flow",
|
|
26
|
+
"Replacing the human review step for generated documentation",
|
|
27
|
+
"Changing the one-spec-one-PR workflow"
|
|
28
|
+
],
|
|
29
|
+
"acceptance": [
|
|
30
|
+
"A generated project contains `docs/AI_ONBOARDING_PROMPT.md` after the onboarding flow",
|
|
31
|
+
"The prompt references the analyzer outputs from slice-01",
|
|
32
|
+
"The prompt has explicit tasks, constraints, validation requirements, and expected final report format",
|
|
33
|
+
"The prompt prevents product-code changes during onboarding unless explicitly authorized",
|
|
34
|
+
"The prompt instructs the AI agent to preserve Quiver workflow invariants",
|
|
35
|
+
"Installer/package smokes fail if the prompt artifact is missing"
|
|
36
|
+
],
|
|
37
|
+
"files": [
|
|
38
|
+
"docs/AI_ONBOARDING_PROMPT.md.template",
|
|
39
|
+
"src/create-quiver/index.js",
|
|
40
|
+
"scripts/init-docs.sh",
|
|
41
|
+
"scripts/ci/smoke-init-docs.sh",
|
|
42
|
+
"scripts/ci/smoke-create-quiver.sh",
|
|
43
|
+
"scripts/package-quiver.sh",
|
|
44
|
+
"README.md",
|
|
45
|
+
"README_FOR_AI.md",
|
|
46
|
+
"docs/INDEX.md.template",
|
|
47
|
+
"docs/WORKFLOW.md.template",
|
|
48
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
49
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md",
|
|
50
|
+
"specs/quiver-v08-agent-onboarding-analysis/slices/slice-02-ai-onboarding-prompt/slice.json"
|
|
51
|
+
],
|
|
52
|
+
"tests": [
|
|
53
|
+
"bash scripts/ci/smoke-init-docs.sh",
|
|
54
|
+
"bash scripts/ci/smoke-create-quiver.sh",
|
|
55
|
+
"bash scripts/package-quiver.sh",
|
|
56
|
+
"Generated prompt content check for required read order and safety constraints"
|
|
57
|
+
],
|
|
58
|
+
"documentation": [
|
|
59
|
+
"README.md",
|
|
60
|
+
"README_FOR_AI.md",
|
|
61
|
+
"docs/INDEX.md.template",
|
|
62
|
+
"docs/WORKFLOW.md.template",
|
|
63
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
64
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md"
|
|
65
|
+
],
|
|
66
|
+
"dependencies": [
|
|
67
|
+
"slice-01-project-scan-command",
|
|
68
|
+
"quiver-v07-ai-context-pack"
|
|
69
|
+
],
|
|
70
|
+
"assumptions": [
|
|
71
|
+
"The prompt is more useful as a generated project file than as a long README block",
|
|
72
|
+
"The analyzer output is available before the AI prompt is run",
|
|
73
|
+
"The AI agent should fill context docs but the human owner remains responsible for review"
|
|
74
|
+
],
|
|
75
|
+
"estimated_hours": 3,
|
|
76
|
+
"actual_hours": 0,
|
|
77
|
+
"status": "draft",
|
|
78
|
+
"blocked_reason": null,
|
|
79
|
+
"ready_at": null,
|
|
80
|
+
"started_at": null,
|
|
81
|
+
"completed_at": null
|
|
82
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-03-doctor-readme-adoption-flow",
|
|
3
|
+
"ticket": "QUIVER-03",
|
|
4
|
+
"type": "docs",
|
|
5
|
+
"title": "Doctor and README Adoption Flow",
|
|
6
|
+
"objective": "Update Quiver's public onboarding guidance so users know exactly what to run after installation and do not confuse explanatory labels with shell commands.",
|
|
7
|
+
"description": "Current doctor output and README guidance validate generated files, but the post-install adoption path is not explicit enough. This slice updates user-facing guidance around init, analyze, doctor, and AI onboarding while keeping commands copy-paste safe.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "docs",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "doctor-readme-adoption-flow",
|
|
12
|
+
"branch_name": "docs/QUIVER-03-doctor-readme-adoption-flow"
|
|
13
|
+
},
|
|
14
|
+
"must": [
|
|
15
|
+
"Update `doctor` next steps to show copy-pasteable commands without prefixing them with words like `Run`",
|
|
16
|
+
"Make `doctor` recommend `create-quiver analyze --dir .` when scan artifacts are missing",
|
|
17
|
+
"Update README quick start with the recommended sequence: init, analyze, doctor, run generated AI prompt",
|
|
18
|
+
"Update README_FOR_AI with the exact agent onboarding responsibility and generated prompt location",
|
|
19
|
+
"Mention path quoting guidance for directories with spaces where commands include absolute paths",
|
|
20
|
+
"Keep the README concise and avoid embedding the full long prompt inline"
|
|
21
|
+
],
|
|
22
|
+
"not_included": [
|
|
23
|
+
"Reworking Windows shell support in this slice",
|
|
24
|
+
"Changing release publishing scripts",
|
|
25
|
+
"Adding AI-provider integrations",
|
|
26
|
+
"Changing project template semantics beyond onboarding guidance",
|
|
27
|
+
"Renaming existing Quiver commands"
|
|
28
|
+
],
|
|
29
|
+
"acceptance": [
|
|
30
|
+
"`create-quiver doctor` output is understandable as guidance and not mistaken for a command containing `Run`",
|
|
31
|
+
"README quick start documents the full adoption path from package install to AI onboarding",
|
|
32
|
+
"README_FOR_AI points agents to `docs/AI_ONBOARDING_PROMPT.md` after analysis",
|
|
33
|
+
"Smoke tests assert the expected onboarding artifacts and doctor guidance exist",
|
|
34
|
+
"Existing init, doctor, and package workflows still pass",
|
|
35
|
+
"The release notes/evidence report record the final user-facing onboarding flow"
|
|
36
|
+
],
|
|
37
|
+
"files": [
|
|
38
|
+
"README.md",
|
|
39
|
+
"README_FOR_AI.md",
|
|
40
|
+
"src/create-quiver/index.js",
|
|
41
|
+
"scripts/ci/smoke-create-quiver.sh",
|
|
42
|
+
"scripts/package-quiver.sh",
|
|
43
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
44
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md",
|
|
45
|
+
"specs/quiver-v08-agent-onboarding-analysis/slices/slice-03-doctor-readme-adoption-flow/slice.json"
|
|
46
|
+
],
|
|
47
|
+
"tests": [
|
|
48
|
+
"node src/create-quiver/index.js doctor --dir <fixture>",
|
|
49
|
+
"bash scripts/ci/smoke-create-quiver.sh",
|
|
50
|
+
"bash scripts/package-quiver.sh",
|
|
51
|
+
"README command snippet check",
|
|
52
|
+
"git diff --check"
|
|
53
|
+
],
|
|
54
|
+
"documentation": [
|
|
55
|
+
"README.md",
|
|
56
|
+
"README_FOR_AI.md",
|
|
57
|
+
"specs/quiver-v08-agent-onboarding-analysis/STATUS.md",
|
|
58
|
+
"specs/quiver-v08-agent-onboarding-analysis/EVIDENCE_REPORT.md"
|
|
59
|
+
],
|
|
60
|
+
"dependencies": [
|
|
61
|
+
"slice-01-project-scan-command",
|
|
62
|
+
"slice-02-ai-onboarding-prompt"
|
|
63
|
+
],
|
|
64
|
+
"assumptions": [
|
|
65
|
+
"The main adoption problem is unclear sequence, not missing package installation mechanics",
|
|
66
|
+
"Doctor should guide next steps but should not run analysis automatically without user intent",
|
|
67
|
+
"Long onboarding instructions belong in generated docs, not in the root README"
|
|
68
|
+
],
|
|
69
|
+
"estimated_hours": 2,
|
|
70
|
+
"actual_hours": 0,
|
|
71
|
+
"status": "draft",
|
|
72
|
+
"blocked_reason": null,
|
|
73
|
+
"ready_at": null,
|
|
74
|
+
"started_at": null,
|
|
75
|
+
"completed_at": null
|
|
76
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Quiver v0.9 Evidence Report
|
|
2
|
+
|
|
3
|
+
**Spec:** quiver-v09-onboarding-readme-flow
|
|
4
|
+
**Last updated:** 2026-04-21
|
|
5
|
+
**Status:** Completed
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
| Slice | Acceptance criteria | Status | Evidence |
|
|
10
|
+
|-------|---------------------|--------|----------|
|
|
11
|
+
| slice-01 | 5 | Completed | `bash scripts/ci/smoke-init-docs.sh` |
|
|
12
|
+
| slice-02 | 5 | Completed | `bash scripts/ci/smoke-create-quiver.sh`, `bash scripts/package-quiver.sh` |
|
|
13
|
+
|
|
14
|
+
## Evidence by Slice
|
|
15
|
+
|
|
16
|
+
### slice-01-developer-readme-onboarding-flow
|
|
17
|
+
|
|
18
|
+
- Reworked the root README around install, analyze, doctor, AI handoff, review, and first-slice execution
|
|
19
|
+
- Updated the generated project README in `scripts/init-docs.sh` with the same onboarding path
|
|
20
|
+
- Added smoke assertions for the generated README AI handoff and context review checklist
|
|
21
|
+
- Verified shell syntax with `bash -n scripts/init-docs.sh scripts/ci/smoke-init-docs.sh`
|
|
22
|
+
- Verified generated README behavior with `bash scripts/ci/smoke-init-docs.sh`
|
|
23
|
+
|
|
24
|
+
### slice-02-ai-handoff-doctor-guidance
|
|
25
|
+
|
|
26
|
+
- Updated `doctor` to require the AI context and onboarding prompt files
|
|
27
|
+
- Made `doctor` point to `docs/AI_ONBOARDING_PROMPT.md` after scan artifacts exist
|
|
28
|
+
- Updated `README_FOR_AI.md` so agents treat onboarding as context preparation before product work
|
|
29
|
+
- Extended `smoke-create-quiver.sh` to assert the new doctor handoff guidance for local and packaged installs
|
|
30
|
+
- Verified syntax with `node -c src/create-quiver/index.js`
|
|
31
|
+
- Verified shell syntax with `bash -n scripts/ci/smoke-create-quiver.sh scripts/package-quiver.sh`
|
|
32
|
+
- Verified end-to-end CLI behavior with `bash scripts/ci/smoke-create-quiver.sh`
|
|
33
|
+
- Verified package contract with `bash scripts/package-quiver.sh`
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Quiver v0.9 - Onboarding README Flow
|
|
2
|
+
|
|
3
|
+
**Date:** 2026-04-21
|
|
4
|
+
**Status:** Completed
|
|
5
|
+
|
|
6
|
+
Slice numbering resets here: this spec starts at `slice-01` and does not continue any previous spec's numbering.
|
|
7
|
+
|
|
8
|
+
## Objective
|
|
9
|
+
|
|
10
|
+
Make the README and generated onboarding docs explain the full developer and AI onboarding path so a new project can prepare context before the first implementation slice.
|
|
11
|
+
|
|
12
|
+
## Scope
|
|
13
|
+
|
|
14
|
+
### Included
|
|
15
|
+
|
|
16
|
+
- Reorder the root README around the developer onboarding flow
|
|
17
|
+
- Update the generated project README so it explains analysis, AI context preparation, and review before slices
|
|
18
|
+
- Make the AI handoff explicit without embedding the full prompt in the README
|
|
19
|
+
- Update `doctor` and AI guidance so the CLI points users to the generated prompt after analysis
|
|
20
|
+
- Extend smoke checks so README onboarding guidance and doctor output stay covered
|
|
21
|
+
|
|
22
|
+
### Excluded
|
|
23
|
+
|
|
24
|
+
- Changing the analyzer behavior
|
|
25
|
+
- Adding provider-specific AI integrations
|
|
26
|
+
- Changing release publishing behavior
|
|
27
|
+
- Reworking Windows-specific shell support
|
|
28
|
+
- Changing the one-slice-one-commit and one-spec-one-PR rules
|
|
29
|
+
|
|
30
|
+
## Slices
|
|
31
|
+
|
|
32
|
+
| Slice | Title | Status | Spec |
|
|
33
|
+
|-------|-------|--------|------|
|
|
34
|
+
| 01 | Developer README Onboarding Flow | Completed | [slice-01](./slices/slice-01-developer-readme-onboarding-flow/slice.json) |
|
|
35
|
+
| 02 | AI Handoff and Doctor Guidance | Completed | [slice-02-ai-handoff-doctor-guidance/slice.json](./slices/slice-02-ai-handoff-doctor-guidance/slice.json) |
|
|
36
|
+
|
|
37
|
+
## Definition of Done
|
|
38
|
+
|
|
39
|
+
- The root README shows the full install, analyze, doctor, AI handoff, review, and first-slice flow
|
|
40
|
+
- The generated project README gives the same operational onboarding path
|
|
41
|
+
- The README tells the developer exactly what to ask the AI agent to do
|
|
42
|
+
- `doctor` points to the generated onboarding prompt once the project has scan artifacts
|
|
43
|
+
- Smoke tests cover the README and doctor onboarding guidance
|
|
44
|
+
- The spec is completed with one commit per slice and one PR for the spec
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Quiver v0.9 Spec Status
|
|
2
|
+
|
|
3
|
+
**Spec:** quiver-v09-onboarding-readme-flow
|
|
4
|
+
**Last updated:** 2026-04-21
|
|
5
|
+
|
|
6
|
+
Slice numbering is local to this spec. The first slice is `slice-01`.
|
|
7
|
+
|
|
8
|
+
## Status
|
|
9
|
+
|
|
10
|
+
| Slice | Title | Status | PR | Estimated hours | Actual hours |
|
|
11
|
+
|-------|-------|--------|----|-----------------|--------------|
|
|
12
|
+
| slice-01 | Developer README Onboarding Flow | Completed | - | 2 | 2 |
|
|
13
|
+
| slice-02 | AI Handoff and Doctor Guidance | Completed | - | 2 | 2 |
|
|
14
|
+
|
|
15
|
+
## Progress
|
|
16
|
+
|
|
17
|
+
- Completed slices: 2 / 2
|
|
18
|
+
- Estimated hours: 4
|
|
19
|
+
- Actual hours: 4
|
|
20
|
+
|
|
21
|
+
## Blockers
|
|
22
|
+
|
|
23
|
+
| Slice | Blocker | Since | Action needed |
|
|
24
|
+
|-------|---------|-------|---------------|
|
|
25
|
+
| - | - | - | - |
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-01-developer-readme-onboarding-flow",
|
|
3
|
+
"ticket": "QUIVER-01",
|
|
4
|
+
"type": "docs",
|
|
5
|
+
"title": "Developer README Onboarding Flow",
|
|
6
|
+
"objective": "Rework the root README and generated project README so developers understand the full Quiver onboarding path before creating implementation slices.",
|
|
7
|
+
"description": "The current README has the required commands, but it does not clearly separate installation, project analysis, AI context preparation, human review, and first slice execution. This slice turns the README into an operational onboarding guide for developers.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "docs",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "onboarding-readme-flow",
|
|
12
|
+
"branch_name": "docs/QUIVER-09-onboarding-readme-flow"
|
|
13
|
+
},
|
|
14
|
+
"must": [
|
|
15
|
+
"Rewrite the root README quick start into a developer onboarding flow",
|
|
16
|
+
"Explain what `create-quiver analyze --dir .` generates and why it exists",
|
|
17
|
+
"Add the exact short instruction developers should give the AI agent after analysis",
|
|
18
|
+
"Move the first-slice workflow after context preparation and human review",
|
|
19
|
+
"Update the generated project README created by `scripts/init-docs.sh` with the same flow"
|
|
20
|
+
],
|
|
21
|
+
"not_included": [
|
|
22
|
+
"Changing `doctor` output",
|
|
23
|
+
"Changing `README_FOR_AI.md`",
|
|
24
|
+
"Adding AI-provider integrations",
|
|
25
|
+
"Changing analyzer behavior"
|
|
26
|
+
],
|
|
27
|
+
"acceptance": [
|
|
28
|
+
"The root README describes install, analyze, doctor, AI handoff, review, and first slice in order",
|
|
29
|
+
"The generated project README tells the developer how to prepare AI context before starting a slice",
|
|
30
|
+
"The README does not embed the full long onboarding prompt",
|
|
31
|
+
"The generated README links to `docs/AI_ONBOARDING_PROMPT.md`",
|
|
32
|
+
"`bash scripts/ci/smoke-init-docs.sh` passes"
|
|
33
|
+
],
|
|
34
|
+
"files": [
|
|
35
|
+
"README.md",
|
|
36
|
+
"scripts/init-docs.sh",
|
|
37
|
+
"scripts/ci/smoke-init-docs.sh",
|
|
38
|
+
"specs/quiver-v09-onboarding-readme-flow/SPEC.md",
|
|
39
|
+
"specs/quiver-v09-onboarding-readme-flow/STATUS.md",
|
|
40
|
+
"specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md",
|
|
41
|
+
"specs/quiver-v09-onboarding-readme-flow/slices/slice-01-developer-readme-onboarding-flow/slice.json"
|
|
42
|
+
],
|
|
43
|
+
"tests": [
|
|
44
|
+
"bash -n scripts/init-docs.sh scripts/ci/smoke-init-docs.sh",
|
|
45
|
+
"bash scripts/ci/smoke-init-docs.sh",
|
|
46
|
+
"git diff --check"
|
|
47
|
+
],
|
|
48
|
+
"documentation": [
|
|
49
|
+
"README.md",
|
|
50
|
+
"specs/quiver-v09-onboarding-readme-flow/SPEC.md",
|
|
51
|
+
"specs/quiver-v09-onboarding-readme-flow/STATUS.md",
|
|
52
|
+
"specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md"
|
|
53
|
+
],
|
|
54
|
+
"dependencies": [
|
|
55
|
+
"quiver-v08-agent-onboarding-analysis"
|
|
56
|
+
],
|
|
57
|
+
"assumptions": [
|
|
58
|
+
"The README should remain concise and point to the generated prompt instead of duplicating it",
|
|
59
|
+
"The developer owns review and approval of AI-generated context docs",
|
|
60
|
+
"Context preparation should happen before first slice execution"
|
|
61
|
+
],
|
|
62
|
+
"estimated_hours": 2,
|
|
63
|
+
"actual_hours": 2,
|
|
64
|
+
"status": "completed",
|
|
65
|
+
"blocked_reason": null,
|
|
66
|
+
"ready_at": "2026-04-21T00:00:00Z",
|
|
67
|
+
"started_at": "2026-04-21T00:00:00Z",
|
|
68
|
+
"completed_at": "2026-04-21T00:00:00Z"
|
|
69
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slice_id": "slice-02-ai-handoff-doctor-guidance",
|
|
3
|
+
"ticket": "QUIVER-02",
|
|
4
|
+
"type": "docs",
|
|
5
|
+
"title": "AI Handoff and Doctor Guidance",
|
|
6
|
+
"objective": "Align AI-facing guidance and doctor output with the README onboarding flow so the CLI tells users when to run the generated prompt.",
|
|
7
|
+
"description": "Once README onboarding is clear, the CLI and AI guide should reinforce the same handoff: analyze the project, validate the generated contract, then ask the AI agent to execute `docs/AI_ONBOARDING_PROMPT.md` before creating slices.",
|
|
8
|
+
"git": {
|
|
9
|
+
"branch_type": "docs",
|
|
10
|
+
"base_branch": "main",
|
|
11
|
+
"branch_slug": "onboarding-readme-flow",
|
|
12
|
+
"branch_name": "docs/QUIVER-09-onboarding-readme-flow"
|
|
13
|
+
},
|
|
14
|
+
"must": [
|
|
15
|
+
"Update `doctor` output to point to `docs/AI_ONBOARDING_PROMPT.md` after scan artifacts exist",
|
|
16
|
+
"Update `README_FOR_AI.md` so agents understand onboarding means preparing context before feature work",
|
|
17
|
+
"Extend create-quiver smoke coverage for the new doctor handoff guidance",
|
|
18
|
+
"Run package smoke to confirm the published template still includes the onboarding artifacts",
|
|
19
|
+
"Close the spec evidence and status files"
|
|
20
|
+
],
|
|
21
|
+
"not_included": [
|
|
22
|
+
"Changing generated prompt content beyond references needed for consistency",
|
|
23
|
+
"Changing analyzer output shape",
|
|
24
|
+
"Changing release publishing behavior",
|
|
25
|
+
"Opening multiple PRs for this spec"
|
|
26
|
+
],
|
|
27
|
+
"acceptance": [
|
|
28
|
+
"After `analyze`, `doctor` tells the developer to run `docs/AI_ONBOARDING_PROMPT.md` with their AI agent",
|
|
29
|
+
"`README_FOR_AI.md` says the initial AI job is context preparation, not product implementation",
|
|
30
|
+
"Smoke tests verify the new doctor output",
|
|
31
|
+
"Package smoke still passes",
|
|
32
|
+
"The spec status and evidence show both slices completed"
|
|
33
|
+
],
|
|
34
|
+
"files": [
|
|
35
|
+
"README_FOR_AI.md",
|
|
36
|
+
"src/create-quiver/index.js",
|
|
37
|
+
"scripts/ci/smoke-create-quiver.sh",
|
|
38
|
+
"scripts/package-quiver.sh",
|
|
39
|
+
"specs/quiver-v09-onboarding-readme-flow/SPEC.md",
|
|
40
|
+
"specs/quiver-v09-onboarding-readme-flow/STATUS.md",
|
|
41
|
+
"specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md",
|
|
42
|
+
"specs/quiver-v09-onboarding-readme-flow/slices/slice-02-ai-handoff-doctor-guidance/slice.json"
|
|
43
|
+
],
|
|
44
|
+
"tests": [
|
|
45
|
+
"node -c src/create-quiver/index.js",
|
|
46
|
+
"bash scripts/ci/smoke-create-quiver.sh",
|
|
47
|
+
"bash scripts/package-quiver.sh",
|
|
48
|
+
"git diff --check"
|
|
49
|
+
],
|
|
50
|
+
"documentation": [
|
|
51
|
+
"README_FOR_AI.md",
|
|
52
|
+
"specs/quiver-v09-onboarding-readme-flow/SPEC.md",
|
|
53
|
+
"specs/quiver-v09-onboarding-readme-flow/STATUS.md",
|
|
54
|
+
"specs/quiver-v09-onboarding-readme-flow/EVIDENCE_REPORT.md"
|
|
55
|
+
],
|
|
56
|
+
"dependencies": [
|
|
57
|
+
"slice-01-developer-readme-onboarding-flow"
|
|
58
|
+
],
|
|
59
|
+
"assumptions": [
|
|
60
|
+
"Doctor should guide next steps but not execute the AI prompt automatically",
|
|
61
|
+
"The generated prompt remains provider-neutral",
|
|
62
|
+
"The same branch can hold both slice commits for one spec PR"
|
|
63
|
+
],
|
|
64
|
+
"estimated_hours": 2,
|
|
65
|
+
"actual_hours": 2,
|
|
66
|
+
"status": "completed",
|
|
67
|
+
"blocked_reason": null,
|
|
68
|
+
"ready_at": "2026-04-21T00:00:00Z",
|
|
69
|
+
"started_at": "2026-04-21T00:00:00Z",
|
|
70
|
+
"completed_at": "2026-04-21T00:00:00Z"
|
|
71
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Quiver v0.10 Evidence Report
|
|
2
|
+
|
|
3
|
+
**Spec:** quiver-v10-local-project-installation-guidance
|
|
4
|
+
**Last updated:** 2026-04-21
|
|
5
|
+
**Status:** Completed
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
| Slice | Acceptance criteria | Status | Evidence |
|
|
10
|
+
|-------|---------------------|--------|----------|
|
|
11
|
+
| slice-01 | 5 | Completed | `bash scripts/ci/smoke-init-docs.sh`, `bash scripts/ci/smoke-create-quiver.sh` |
|
|
12
|
+
|
|
13
|
+
## Evidence by Slice
|
|
14
|
+
|
|
15
|
+
### slice-01-local-project-installation-guidance
|
|
16
|
+
|
|
17
|
+
- Updated the root README to prioritize running Quiver from the target project root with `npx`
|
|
18
|
+
- Documented project-local pinned installation with `npm install --save-dev create-quiver`
|
|
19
|
+
- Explicitly discouraged global installation
|
|
20
|
+
- Updated generated README guidance in `scripts/init-docs.sh`
|
|
21
|
+
- Updated AI-facing guidance in `README_FOR_AI.md` and `docs/AI_CONTEXT.md.template`
|
|
22
|
+
- Added smoke assertions for generated README guidance
|
|
23
|
+
- Verified shell syntax with `bash -n scripts/init-docs.sh scripts/ci/smoke-init-docs.sh scripts/ci/smoke-create-quiver.sh`
|
|
24
|
+
- Verified generated docs with `bash scripts/ci/smoke-init-docs.sh`
|
|
25
|
+
- Verified CLI smoke with `bash scripts/ci/smoke-create-quiver.sh`
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Quiver v0.10 - Local Project Installation Guidance
|
|
2
|
+
|
|
3
|
+
**Date:** 2026-04-21
|
|
4
|
+
**Status:** Completed
|
|
5
|
+
|
|
6
|
+
Slice numbering resets here: this spec starts at `slice-01` and does not continue any previous spec's numbering.
|
|
7
|
+
|
|
8
|
+
## Objective
|
|
9
|
+
|
|
10
|
+
Clarify that Quiver should be run from the project where the workflow will live, preferably through `npx`, and should not be installed globally.
|
|
11
|
+
|
|
12
|
+
## Scope
|
|
13
|
+
|
|
14
|
+
### Included
|
|
15
|
+
|
|
16
|
+
- Update the root README to recommend running Quiver from the project root
|
|
17
|
+
- Make `npx create-quiver --name "Project Name"` the primary path
|
|
18
|
+
- Document `npm install --save-dev create-quiver` as the pinned project-local option
|
|
19
|
+
- Explicitly discourage global installation
|
|
20
|
+
- Update generated project README and AI-facing docs with the same guidance
|
|
21
|
+
- Add smoke checks for the new guidance
|
|
22
|
+
|
|
23
|
+
### Excluded
|
|
24
|
+
|
|
25
|
+
- CLI behavior changes
|
|
26
|
+
- npm package version changes
|
|
27
|
+
- Release publishing
|
|
28
|
+
- Windows-specific installation changes
|
|
29
|
+
|
|
30
|
+
## Slices
|
|
31
|
+
|
|
32
|
+
| Slice | Title | Status | Spec |
|
|
33
|
+
|-------|-------|--------|------|
|
|
34
|
+
| 01 | Local Project Installation Guidance | Completed | [slice-01](./slices/slice-01-local-project-installation-guidance/slice.json) |
|
|
35
|
+
|
|
36
|
+
## Definition of Done
|
|
37
|
+
|
|
38
|
+
- The README tells developers to run Quiver from the target project root
|
|
39
|
+
- The README does not recommend global installation
|
|
40
|
+
- The generated project README includes the same local-project guidance
|
|
41
|
+
- AI-facing docs refer to the local project root as the operating context
|
|
42
|
+
- Smoke checks verify the generated README guidance
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Quiver v0.10 Spec Status
|
|
2
|
+
|
|
3
|
+
**Spec:** quiver-v10-local-project-installation-guidance
|
|
4
|
+
**Last updated:** 2026-04-21
|
|
5
|
+
|
|
6
|
+
Slice numbering is local to this spec. The first slice is `slice-01`.
|
|
7
|
+
|
|
8
|
+
## Status
|
|
9
|
+
|
|
10
|
+
| Slice | Title | Status | PR | Estimated hours | Actual hours |
|
|
11
|
+
|-------|-------|--------|----|-----------------|--------------|
|
|
12
|
+
| slice-01 | Local Project Installation Guidance | Completed | - | 1 | 1 |
|
|
13
|
+
|
|
14
|
+
## Progress
|
|
15
|
+
|
|
16
|
+
- Completed slices: 1 / 1
|
|
17
|
+
- Estimated hours: 1
|
|
18
|
+
- Actual hours: 1
|
|
19
|
+
|
|
20
|
+
## Blockers
|
|
21
|
+
|
|
22
|
+
| Slice | Blocker | Since | Action needed |
|
|
23
|
+
|-------|---------|-------|---------------|
|
|
24
|
+
| - | - | - | - |
|