Skip to content

Clarify Week 1 demo UI boundary#13

Merged
Abiorh001 merged 2 commits into
mainfrom
fix-week1-demo-ui-labeling
Jun 9, 2026
Merged

Clarify Week 1 demo UI boundary#13
Abiorh001 merged 2 commits into
mainfrom
fix-week1-demo-ui-labeling

Conversation

@Abiorh001

@Abiorh001 Abiorh001 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • move the Week 1 React/Vite walkthrough client from root frontend/ into demos/week1_api_demo_ui/
  • rename the CI workflow to Week 1 API Demo UI and point it at the demo path
  • update README, package names, and architecture brief wording so the demo is not confused with the planned Workstream operations UI
  • re-render the v0.1 container diagram and architecture brief PDF

Verification

  • npm ci && npm run build from demos/week1_api_demo_ui
  • Markdown links OK
  • stale wording scan only hits the intentional banned-word guardrail in AGENTS.md
  • git diff --check
  • no local XLSX export present
  • pdfinfo docs/architecture_brief/workstream_architecture_brief.pdf

Summary by CodeRabbit

  • Documentation

    • Updated README with revised demo setup and startup instructions for the Week 1 API Demo UI
    • Clarified v0.1 architecture scope, distinguishing planned internal operations interface from the temporary demo walkthrough
    • Updated demo page title and in-app messaging to reference “Week 1 API Demo”
  • Chores

    • Updated CI workflow to build the demo UI
    • Updated ignore patterns for demo build artifacts

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e00705bc-419a-464c-8ac9-141e85aaee73

📥 Commits

Reviewing files that changed from the base of the PR and between dc0ceda and 9ecf915.

⛔ Files ignored due to path filters (3)
  • docs/architecture_brief/images/workstream_v01_container.png is excluded by !**/*.png
  • docs/architecture_brief/workstream_architecture_brief.pdf is excluded by !**/*.pdf
  • docs/diagrams/rendered/workstream_v01_container.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • docs/diagrams/workstream_v01_container.puml
✅ Files skipped from review due to trivial changes (1)
  • docs/diagrams/workstream_v01_container.puml

📝 Walkthrough

Walkthrough

This PR renames and reconfigures the repository's demo UI from generic "frontend" naming to "Week 1 API Demo UI", updating CI build steps, .gitignore, demo package and HTML metadata, API request strings in the demo app, and architecture/documentation references.

Changes

Week 1 API Demo UI Rebrand

Layer / File(s) Summary
CI/Build Configuration and Git Ignore
.github/workflows/week1-api-demo-ui.yml, .gitignore
GitHub Actions workflow name and job key updated; npm cache/install/build steps now run in demos/week1_api_demo_ui/ with its package-lock path. .gitignore now excludes demos/week1_api_demo_ui/node_modules/ and demos/week1_api_demo_ui/dist/.
Demo UI Package Metadata
demos/week1_api_demo_ui/package.json, demos/week1_api_demo_ui/index.html
Package name changed to workstream-week1-api-demo-ui; HTML <title> updated to "Workstream Week 1 API Demo".
Demo UI API Call Strings
demos/week1_api_demo_ui/src/App.tsx
change_summary and reason payload strings updated across guide patch, task screening/release, and worker claim/start flows in both individual steps and the runAll() sequence to use "Week 1 API demo" wording.
Documentation and Architecture Clarification
README.md, docs/architecture_brief/workstream_architecture_brief.md, docs/diagrams/workstream_v01_container.md, docs/diagrams/workstream_v01_container.puml
README grammar adjusted; local demo section replaced with "Week 1 API Demo UI" setup and instructions. Architecture docs and diagram labels revised to call the planned UI "React + Vite operations UI" and to note the demo is a separate walkthrough client under demos/.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hop through code with tiny feet,
I tweak the names and make them neat,
A demo born for week one play,
It calls the API in a friendly way,
A rabbit's cheer for tidy feet!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately captures the main objective: clarifying the boundary between the Week 1 demo UI and the planned operations UI by repositioning demo content and updating nomenclature throughout the codebase.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-week1-demo-ui-labeling

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/diagrams/workstream_v01_container.puml`:
- Line 40: Update the diagram label for the rectangle symbol named frontend
(currently "React + Vite Operations UI\n----\nPlanned internal\noperations
interface") to use the term "dashboard" instead of "interface" so it reads
"React + Vite Operations UI\n----\nPlanned internal\noperations dashboard" to
match the architecture brief wording in workstream_architecture_brief.md.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 52fd4ceb-403f-4bc2-8eec-fcb7ebce9058

📥 Commits

Reviewing files that changed from the base of the PR and between 9ec2dd7 and dc0ceda.

⛔ Files ignored due to path filters (4)
  • demos/week1_api_demo_ui/package-lock.json is excluded by !**/package-lock.json
  • docs/architecture_brief/images/workstream_v01_container.png is excluded by !**/*.png
  • docs/architecture_brief/workstream_architecture_brief.pdf is excluded by !**/*.pdf
  • docs/diagrams/rendered/workstream_v01_container.svg is excluded by !**/*.svg
📒 Files selected for processing (15)
  • .github/workflows/week1-api-demo-ui.yml
  • .gitignore
  • README.md
  • demos/week1_api_demo_ui/index.html
  • demos/week1_api_demo_ui/package.json
  • demos/week1_api_demo_ui/src/App.tsx
  • demos/week1_api_demo_ui/src/api.ts
  • demos/week1_api_demo_ui/src/main.tsx
  • demos/week1_api_demo_ui/src/styles.css
  • demos/week1_api_demo_ui/tsconfig.app.json
  • demos/week1_api_demo_ui/tsconfig.json
  • demos/week1_api_demo_ui/vite.config.ts
  • docs/architecture_brief/workstream_architecture_brief.md
  • docs/diagrams/workstream_v01_container.md
  • docs/diagrams/workstream_v01_container.puml

Comment thread docs/diagrams/workstream_v01_container.puml Outdated
@Abiorh001 Abiorh001 merged commit a08a521 into main Jun 9, 2026
3 checks passed
@Abiorh001 Abiorh001 deleted the fix-week1-demo-ui-labeling branch June 9, 2026 11:50
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