Skip to content

docs: progressive disclosure README — Level 0/1/2 paths#2

Merged
zkSoju merged 1 commit intomainfrom
feat/phase2-readme-progressive-disclosure
Mar 5, 2026
Merged

docs: progressive disclosure README — Level 0/1/2 paths#2
zkSoju merged 1 commit intomainfrom
feat/phase2-readme-progressive-disclosure

Conversation

@zkSoju
Copy link
Copy Markdown
Contributor

@zkSoju zkSoju commented Mar 5, 2026

Summary

  • Replaces monolithic 352-line README with graduated 195-line version
  • Level 0: Ship in 5 minutes — 3 files to edit, push, done
  • Level 1: Understand the structure — skills, identity, CLAUDE.md explained
  • Level 2: Advanced features — events, golden path, capability metadata
  • Documents the template overhaul: real example skills, graduated CI, dual identity layer
  • Reflects kishōtenketsu file structure philosophy

Context

Phase 2 of escape-velocity strategy. The README itself now embodies progressive disclosure — the principle the template teaches.

Test plan

  • Level 0 quick start steps are accurate and complete
  • File tree matches actual repo structure post-merge
  • All links resolve

🤖 Generated with Claude Code

Replace monolithic README with graduated structure:
- Level 0: Ship in 5 minutes (3 files to edit, push)
- Level 1: Understand the structure (skills, identity, CLAUDE.md)
- Level 2: Advanced features (events, golden path, capability metadata)

Reflects template overhaul: real example skills, graduated CI,
dual identity layer, kishōtenketsu file structure.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@zkSoju zkSoju merged commit ef9f139 into main Mar 5, 2026
2 checks passed
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: c2717d658f

ℹ️ 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".

Comment on lines +17 to +20
# 2. Edit three files
# construct.yaml → name, slug, description, author
# skills/example-simple/SKILL.md → your skill's instructions
# CLAUDE.md → your construct's identity
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Restore command template customization in Level 0 quick start

The new Level 0 path says to edit only three files, but construct.yaml still maps the primary /quick-review command to commands/example-command.md, whose content is placeholder text that tells the agent to execute example-skill (a skill that is no longer declared). In practice, users who follow this onboarding flow can ship a construct whose main command runs stale instructions, so Level 0 should also require updating the command template (or point to a non-placeholder command file by default).

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