Phase 4: bundled demo project for an instant Hub preview - #29
Merged
Conversation
Add examples/demo/ — a realistic mid-flight snapshot so 'node hub/server.js examples/demo' shows a populated board out of the box: three tickets (done / in-review / in-dev), a regulated-preset gate board for the active ticket (with a *rejected* CODE_REVIEWED — the review caught a token-TTL / rate-limit issue), and two knowledge-base docs. File-based only (.aidevteam/workflow.yaml, .workflow-state.json, docs/). - .gitignore: keep examples/demo/.workflow-state.json tracked (the generated-ledger ignore rule would otherwise exclude the demo fixture). - README + hub/README: point the Hub usage examples at the bundled demo.
There was a problem hiding this comment.
Pull request overview
Adds a bundled examples/demo/ project snapshot to make the local Hub instantly previewable (tickets + gate board + KB docs) without requiring users to create their own workflow state first.
Changes:
- Adds
examples/demo/with a workflow definition, canonical.workflow-state.jsonledger, and two KB markdown docs. - Updates top-level docs (
README.md,hub/README.md) to point to the bundled demo for a one-command Hub preview. - Adjusts
.gitignoreto keep the demo’s.workflow-state.jsonfixture tracked despite the global ignore rule.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds “run Hub with examples/demo” quickstart and explains what the demo contains. |
| hub/README.md | Documents the bundled demo as the fastest way to see Hub populated. |
| examples/demo/README.md | Introduces the demo project contents and how to run Hub against it. |
| examples/demo/docs/security-review-adt-124.md | Adds a sample SECOPS review doc for the demo ticket. |
| examples/demo/docs/adr-001-password-reset.md | Adds a sample ADR doc backing the demo’s ticket narrative. |
| examples/demo/.workflow-state.json | Adds a demo ledger with 3 tickets and gate states for Hub rendering. |
| examples/demo/.aidevteam/workflow.yaml | Adds a demo workflow definition used to render gates/preset requirements. |
| .gitignore | Un-ignores the demo ledger fixture so it remains committed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Demo workflow.yaml header now states it is a project OVERRIDE (not the shipped default), clarifying the resolution cascade. - The demo's regulated preset keeps all backends file-based (backlog_md/markdown) so the 'no setup' claim holds even if run through the engine, not just the Hub. - Align the CODE_REVIEWED rejection narrative with the ADR/SECOPS docs: the issue is the missing rate-limit on the reset endpoint (ADT-130 follow-up), not the 15m token TTL (which both docs accept). Fixed in the ledger note + demo README.
…proportionality Annotate the demo's 'preset: regulated' and the proportionality comment to make clear the demo intentionally pins regulated (always_required forces the heavy gates), while the default solo preset forces nothing and lets proportionality classify.
…he Hub The demo header now lists the Hub's actual 4-step resolution (adds the project-scope .claude/workflow/ install step) and notes how it relates to the engine's documented 1-2 -> shipped-default contract.
Use 'SecOps' for the role/team in demo prose (README + ADR), reserving all-caps for the gate name SECOPS_APPROVED.
olehsvyrydov
added a commit
that referenced
this pull request
Jun 6, 2026
* Phase 4: bundled demo project for an instant Hub preview Add examples/demo/ — a realistic mid-flight snapshot so 'node hub/server.js examples/demo' shows a populated board out of the box: three tickets (done / in-review / in-dev), a regulated-preset gate board for the active ticket (with a *rejected* CODE_REVIEWED — the review caught a token-TTL / rate-limit issue), and two knowledge-base docs. File-based only (.aidevteam/workflow.yaml, .workflow-state.json, docs/). - .gitignore: keep examples/demo/.workflow-state.json tracked (the generated-ledger ignore rule would otherwise exclude the demo fixture). - README + hub/README: point the Hub usage examples at the bundled demo. * Address Copilot review on PR #29: demo fixture consistency - Demo workflow.yaml header now states it is a project OVERRIDE (not the shipped default), clarifying the resolution cascade. - The demo's regulated preset keeps all backends file-based (backlog_md/markdown) so the 'no setup' claim holds even if run through the engine, not just the Hub. - Align the CODE_REVIEWED rejection narrative with the ADR/SECOPS docs: the issue is the missing rate-limit on the reset endpoint (ADT-130 follow-up), not the 15m token TTL (which both docs accept). Fixed in the ledger note + demo README. * Address Copilot re-review on PR #29: clarify demo's pinned preset vs proportionality Annotate the demo's 'preset: regulated' and the proportionality comment to make clear the demo intentionally pins regulated (always_required forces the heavy gates), while the default solo preset forces nothing and lets proportionality classify. * Address Copilot re-review on PR #29: align demo header cascade with the Hub The demo header now lists the Hub's actual 4-step resolution (adds the project-scope .claude/workflow/ install step) and notes how it relates to the engine's documented 1-2 -> shipped-default contract. * Address Copilot re-review on PR #29: SecOps capitalization in prose Use 'SecOps' for the role/team in demo prose (README + ADR), reserving all-caps for the gate name SECOPS_APPROVED. * Demo: SecOps casing in the ledger rejection note too (consistency) * Address Copilot re-review on PR #29: clarify the demo runs from the repo root
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
examples/demo/— a realistic mid-flight project snapshot so the Hub is impressive in one command (no setup, screenshot-ready):node hub/server.js examples/demo # open http://localhost:4477It shows:
ADT-118(done),ADT-124(in review),ADT-130(in dev).regulatedpreset —CODE_REVIEWEDis rejected (the review caught a missing rate-limit on the reset endpoint (ADT-130 follow-up)),SECOPS_APPROVEDcarriessafety-override, others passed/pending.All file-based:
.aidevteam/workflow.yaml,.workflow-state.json(canonical ledger),docs/.Notes
.gitignorekeepsexamples/demo/.workflow-state.jsontracked (the generated-ledger ignore rule would otherwise drop the fixture).Verification