docs: add project-config demo guide

[TabishB]

Summary

• Adds a quick-reference demo guide for the openspec/config.yaml feature
• Consolidates demo walkthrough into a standalone document for easier presentation

Content

• Summary of what project config does (schema defaults, context injection, per-artifact rules)
• 6 numbered demo scenarios covering interactive setup, manual creation, schema effects, context/rules injection, precedence, and error handling
• Quick all-in-one demo script
• Key points to emphasize when demoing

Test plan

• Verify markdown renders correctly
• Confirm all code blocks are properly formatted
• Check links to related documentation

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added comprehensive project configuration guide with step-by-step demos, setup examples, configuration walkthroughs, and validation scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A new comprehensive documentation file is added detailing the project config feature for openspec/config.yaml, including examples, multi-scenario walkthroughs, and guidance on configuring default schemas, context injection, and per-artifact rules.

Changes

Cohort / File(s)	Summary
Documentation docs/project-config-demo.md	New file (+205 lines) providing comprehensive guide to project config feature with multi-demo walkthrough, interactive setup examples, context/rules injection patterns, validation scenarios, and related references

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Possibly related PRs

• docs: add guidance for populating project-level context #241: Both PRs add documentation for setting project-level context/config in OpenSpec, covering complementary aspects of project configuration guidance.

Poem

🐰 A config guide so clear and bright,
With demos, rules, and contexts right,
The schema dances, schemas flow,
Let validation greenlight show! ✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[vibe-kanban-cloud]

Review Complete

Your review story is ready!

View Story

Comment !reviewfast on this PR to re-generate the story.

[greptile-apps]

Greptile Summary

Adds a comprehensive demo guide for the openspec/config.yaml feature, consolidating demonstration instructions into a single reference document.

The guide includes:

• Clear explanation of project config capabilities (schema defaults, context injection, per-artifact rules)
• 6 detailed demo scenarios covering setup, creation, effects, injection, precedence, and validation
• Quick all-in-one demo script for presentations
• Key emphasis points for demonstrations
• Links to related documentation

The documentation is well-structured, technically accurate based on the schema definitions, and provides practical examples that align with the experimental workflow guide. All artifact IDs referenced (proposal, specs, design, tasks for spec-driven; spec, tests, implementation, docs for tdd) match the actual schema definitions. The demo scenarios are logical and build progressively from simple to complex use cases.

Confidence Score: 5/5

• This PR is safe to merge with minimal risk
• This is a documentation-only PR that adds a new demo guide. The content is technically accurate (verified against actual schema files), well-structured, and doesn't modify any code or existing documentation. All referenced artifact IDs, file paths, and commands align with the existing codebase. The guide complements the existing experimental-workflow.md without conflicts.
• No files require special attention

Important Files Changed

Filename	Overview
docs/project-config-demo.md	New demo guide for project config feature - well-structured with clear examples and comprehensive walkthrough scenarios

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as OpenSpec CLI
    participant Config as openspec/config.yaml
    participant Schema as Schema System
    participant AI as AI Assistant

    Note over User,AI: Demo 1: Interactive Setup
    User->>CLI: openspec artifact-experimental-setup
    CLI->>User: Prompt: Create openspec/config.yaml?
    User->>CLI: Yes
    CLI->>User: Select schema (spec-driven/tdd)
    User->>CLI: spec-driven
    CLI->>User: Open editor for context
    User->>CLI: Provide tech stack & conventions
    CLI->>User: Select artifacts for rules
    User->>CLI: proposal, specs
    CLI->>User: Enter rules per artifact
    User->>CLI: Provide rules
    CLI->>Config: Write config.yaml

    Note over User,AI: Demo 3: Effect on New Changes
    User->>CLI: openspec new change my-feature
    CLI->>Config: Read default schema
    Config-->>CLI: schema: spec-driven
    CLI->>Schema: Use spec-driven schema
    Schema-->>CLI: Change created

    Note over User,AI: Demo 4: Context and Rules Injection
    User->>CLI: openspec instructions proposal --change my-feature
    CLI->>Config: Read context & rules
    Config-->>CLI: context + proposal rules
    CLI->>Schema: Get proposal template
    Schema-->>CLI: proposal template
    CLI->>CLI: Inject <context> and <rules> tags
    CLI->>User: Return enriched instructions
    User->>AI: Use instructions to create artifact
    AI->>AI: Apply context & rules
    AI-->>User: Generated artifact

Loading