Skip to content

docs: refresh template README - #14

Merged
DeyangChan merged 1 commit into
mainfrom
docs/readme-refresh
Aug 1, 2026
Merged

docs: refresh template README#14
DeyangChan merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@DeyangChan

Copy link
Copy Markdown
Contributor

Summary

  • Reframe the template README around a clearer product promise and faster start path.
  • Explain how base contracts, one stack pack, and chosen add-ons compose a project.
  • State explicitly that the template reflects Cavalry Collective's design and software engineering philosophy, not a universal standard.
  • Preserve the Day-1 setup, workflow, support, security, and licensing guidance.

Spec: N/A — documentation-only refresh with no product behaviour change.

Test plan

  • Repository document and contract checks report 0 problem(s).
  • git diff --check passes.
  • Every relative README link resolves through the repository integrity check.
  • The changed README was reviewed end to end against the live Visual Stack README.

Notes

  • New abstraction / dependency / config key: none added.
  • Pattern followed: the current Cavalry-Collective/visual-stack README's product-led structure, adapted to this template's purpose.

@DeyangChan
DeyangChan merged commit ebe17c2 into main Aug 1, 2026
1 check passed
@DeyangChan
DeyangChan deleted the docs/readme-refresh branch August 1, 2026 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant