Purposeful project scaffold
Delivery Summary
- Beads feature root:
dstack-mol-ln9 - Status: delivered
- Pull request: not created
- Merge commit:
8a7e015d4e663e9f4ea3f670765f5cd3482ad790(fast-forward) - Design record: design.md
Delivered Capability
New-project setup now requires an explicit purpose, intended users, current scope, boundaries, and one of seven project kinds. Copier renders a small factual mdBook from that brief instead of generating empty documentation categories or replacement instructions.
User-Facing Behavior
/setup-project asks one question for each missing brief field and project kind. Direct helper invocation requires
--purpose, --users, --scope, --boundaries, and --project-kind. Blank values, NUL, CR, LF, and unsupported
kinds fail before rendering with field-specific guidance.
Every kind receives the same initial reader pages: project overview, documentation conventions, feature lifecycle,
planned features, and implemented features. Kind changes only future documentation-concern guidance. Brief punctuation
is preserved literally in Markdown and safely encoded in book.toml.
Design Integration
The implementation preserves Copier’s two entry points, update-source recording, unsafe=False, no-overwrite behavior,
existing-project routing, Git/Beads setup, and post-render validation. The structured brief is the only source for
initial product facts. Both documentation checker copies now validate the pages a project publishes without requiring a
fixed taxonomy.
Operational Impact
This is an intentional pre-1.0 breaking input change. Old project_description answer sets are not accepted or silently
translated. New setup calls must provide the five structured fields. Existing managed-project and migration routing
remains unchanged.
Reference and Contracts
- Project overview
- Workflow architecture
- Install and use dstack
- Developing dstack
- Repository and command reference
Validation Evidence
uv run pytest -m "not external": all 116 applicable tests passed; 1 tag-only test skipped and 1 external test deselected.- Scaffold matrix: 14 independent kind/entrypoint cases and 28 real Copier renders across both README states passed.
uv run scripts/check-docs.py: passed.mise run check: passed, including mdBook build and repository quality checks.- Generated documentation checker and mdBook build passed for every matrix render.
- Final holistic delivery and documentation-drift reviews passed with no unresolved blocker after fixes.
mainfast-forwarded to8a7e015d4e663e9f4ea3f670765f5cd3482ad790.
Design Reconciliation
Delivered as Designed
The exact structured input contract, seven kinds, universal factual reader file set, kind-specific future guidance, variable documentation checker, and safety regression matrix match the reviewed design.
Intentional Changes
None from the reviewed implementation-ready design.
Deferred Work
Restoring structured-brief support in managed-project adoption is tracked by dstack-ub6. Universal tooling, language
profiles, GitHub delivery, and monorepo layout remain owned by Universal project tooling through Monorepo tooling
layout.
Rejected or Removed Scope
The feature does not infer missing answers, preserve the old free-form description, generate application source, or create speculative architecture, operations, development-overview, or reference-overview pages.
Documentation Updated
docs/src/introduction/project-overview.mddocs/src/architecture/index.mddocs/src/operations/index.mddocs/src/development/index.mddocs/src/reference/index.mddocs/src/planned-features.mddocs/src/features/index.mddocs/src/SUMMARY.mddocs/src/features/purposeful-project-scaffold/index.md
Audit Trail
- Specification reconciliation:
112d121, with roadmap readiness at353c8ce. - Structured inputs (
dstack-mol-a8i.1):1ba43242d37aa174a452ec1ec10e99c1305e42f5. - Factual generated documentation (
dstack-mol-a8i.2):1497515f92004eba5354b68f33cde7319123bd09. - Variable-taxonomy checker (
dstack-mol-a8i.3):c0269638805f1613ec63ec76fc6c222393c1d412. - Complete scaffold matrix (
dstack-mol-a8i.4):f665b30171040c301b575e1b7ddb8e3b9a32487e. - Implementation coordinator
dstack-mol-a8iclosed after all four children and acceptance checks completed.