Skip to content

feat(ce-strategy): move strategy doc to root and add frontmatter#732

Merged
tmchow merged 1 commit intomainfrom
tmchow/strategy-md-spec
May 1, 2026
Merged

feat(ce-strategy): move strategy doc to root and add frontmatter#732
tmchow merged 1 commit intomainfrom
tmchow/strategy-md-spec

Conversation

@tmchow
Copy link
Copy Markdown
Collaborator

@tmchow tmchow commented May 1, 2026

Summary

Strategy doc is now a canonical root-level file (STRATEGY.md, peer of README.md), with minimal YAML frontmatter so downstream skills consume the product name and last-updated date programmatically instead of scraping prose. /ce-strategy writes the new path; ce-plan, ce-brainstorm, ce-ideate, and ce-product-pulse read it as grounding.

Why root

Strategy is the durable upstream anchor every downstream skill grounds against, the same role README.md, LICENSE, and emerging conventions like DESIGN.md play. Burying it in docs/ framed it as one of many project docs; promoting to root makes the intent obvious from a directory listing.

Why frontmatter

ce-product-pulse already parses the H1 to extract the product name and an italic prose line for the last-updated date. A two-key YAML block (name, last_updated) gives a stable surface without scaffolding. Kept deliberately minimal: no version:, no type:, no $schema:. The filename declares identity for canonical files; version metadata earns its way in only when a consumer needs it.

No migration logic

The skill has small enough usage that state-tracking a one-time prompt about moving old docs/strategy.md files isn't justified. Existing users see a clean first-run on next /ce-strategy; the old file stays untouched until they delete it manually. Reconsider if usage grows.

Test plan

bun test (1025 pass) and bun run release:validate (clean).


Compound Engineering
Claude Code

Promote the strategy doc from `docs/strategy.md` to a root-level
`STRATEGY.md` so it sits as a canonical, well-known file alongside
`README.md` -- following the same convention as DESIGN.md and other
emerging "spec at the root" patterns.

Add minimal YAML frontmatter (`name`, `last_updated`) to the template,
and drop the in-prose `_Last updated_` line so there's a single
source of truth for the date. `ce-product-pulse` now prefers the
frontmatter `name` for product-name extraction, falling back to the
H1 title when frontmatter is absent.

Update downstream skills that read the strategy doc as grounding --
`ce-plan`, `ce-brainstorm`, `ce-ideate`, `ce-product-pulse` -- to
read the new root path. No migration logic for existing
`docs/strategy.md` files: usage is small enough that state-tracking a
one-time prompt isn't justified. Existing users will see a clean
first-run on next `/ce-strategy`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tmchow tmchow merged commit 265cb42 into main May 1, 2026
2 checks passed
@github-actions github-actions Bot mentioned this pull request May 1, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6f0e829045

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

~~~markdown
# {{product_name}} Strategy
---
name: {{product_name}}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Quote the frontmatter name value

Writing name: {{product_name}} as an unquoted YAML scalar can produce invalid frontmatter when the product name contains YAML-significant characters (for example : or #), which breaks the new “programmatic” consumption path introduced in this commit (e.g., ce-product-pulse seeding from frontmatter). This should be emitted as a quoted string in the template so common product names always parse reliably.

Useful? React with 👍 / 👎.

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