Skip to content

Repo hygiene cleanup#394

Merged
RtlZeroMemory merged 1 commit intomainfrom
repo-hygiene-cleanup
Apr 17, 2026
Merged

Repo hygiene cleanup#394
RtlZeroMemory merged 1 commit intomainfrom
repo-hygiene-cleanup

Conversation

@RtlZeroMemory
Copy link
Copy Markdown
Owner

@RtlZeroMemory RtlZeroMemory commented Apr 17, 2026

Summary

  • remove the unreferenced Assets/ media folder, the stale migrate-constraints-to-helpers script, and the nested lockfile under examples/regression-dashboard
  • rewrite docs to drop migration and legacy framing where current behavior is the only supported path, and move the remaining useful content to canonical guide/styling pages
  • align CLAUDE.md, AGENTS.md, and the Claude/Codex skills with the current template set, routing examples, and theme/layout guidance
  • clean stale script, example, and renderer references so repo metadata and internal guidance match the current codebase

Validation

  • npm run test:scripts
  • npm run quality:guardrails
  • npm run typecheck
  • npm run docs:build
  • npm run build
  • npm run check:create-rezi-templates
  • npm run test:packages

Summary by CodeRabbit

  • New Features

    • Enhanced screen creation patterns with ui.page() and ui.appShell() as recommended root containers.
  • Documentation

    • Updated routing examples with clearer route naming.
    • Simplified theme documentation; removed legacy null-case handling.
    • Clarified constraint and layout patterns terminology.
    • Streamlined contributing and releasing guides.
  • Improvements

    • Updated widget lab banner labels for clarity.
    • Added regression-dashboard and gallery examples to repo layout documentation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 17, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b3e16f38-063b-4fba-881e-825cc800105c

📥 Commits

Reviewing files that changed from the base of the PR and between cab3dd5 and 5815784.

⛔ Files ignored due to path filters (10)
  • Assets/RENDERING.png is excluded by !**/*.png
  • Assets/REZI-BENCH.gif is excluded by !**/*.gif
  • Assets/REZI-CONSOLE.gif is excluded by !**/*.gif
  • Assets/REZI-CONSOLE2.gif is excluded by !**/*.gif
  • Assets/REZIBENCHMARK.gif is excluded by !**/*.gif
  • Assets/REZICONSOLE.gif is excluded by !**/*.gif
  • Assets/REZICONSOLE3.gif is excluded by !**/*.gif
  • Assets/REZICORE.gif is excluded by !**/*.gif
  • Assets/REZI_MAIN.png is excluded by !**/*.png
  • examples/regression-dashboard/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (44)
  • .claude/skills/rezi-create-screen/SKILL.md
  • .claude/skills/rezi-routing/SKILL.md
  • .codex/skills/rezi-create-screen/SKILL.md
  • .codex/skills/rezi-routing/SKILL.md
  • .gitignore
  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • RELEASING.md
  • docs/backend/terminal-caps.md
  • docs/dev/releasing.md
  • docs/dev/repo-layout.md
  • docs/getting-started/examples.md
  • docs/guide/composition.md
  • docs/guide/constraint-patterns.md
  • docs/guide/constraints.md
  • docs/guide/hooks-reference.md
  • docs/guide/input-and-focus.md
  • docs/guide/layout.md
  • docs/guide/widget-authoring.md
  • docs/index.md
  • docs/packages/core.md
  • docs/styling/defaults.md
  • docs/styling/focus-styles.md
  • docs/styling/theme.md
  • docs/widgets/focus-trap.md
  • docs/widgets/focus-zone.md
  • docs/widgets/stack.md
  • examples/regression-dashboard/src/theme.ts
  • knip.json
  • mkdocs.yml
  • package.json
  • packages/core/src/renderer/renderToDrawlist/boxBorder.ts
  • packages/core/src/renderer/renderToDrawlist/simpleVNode.ts
  • packages/core/src/renderer/renderToDrawlist/spacing.ts
  • packages/create-rezi/src/__tests__/scaffold.test.ts
  • scripts/__tests__/hsr-widget-demo-feedback.test.mjs
  • scripts/__tests__/hsr-widget-self-edit.test.mjs
  • scripts/check-create-rezi-templates.mjs
  • scripts/hsr/widget-demo-feedback.mjs
  • scripts/hsr/widget-view-self-edit.mjs
  • scripts/hsr/widget-view.mjs
  • scripts/migrate-constraints-to-helpers.mjs
  • scripts/rezi-snap.mjs

📝 Walkthrough

Walkthrough

This PR consolidates and modernizes documentation and configuration across the repository. It removes legacy patterns and migration tools, reorganizes root-level documentation into a docs/dev/ directory structure, updates template references from "animation-lab" to "starship," simplifies theme handling by removing null-conditional logic, and updates terminology throughout to remove legacy language. Multiple scripts and configuration files are adjusted accordingly.

Changes

Cohort / File(s) Summary
AI Skill Documentation
.claude/skills/rezi-create-screen/SKILL.md, .codex/skills/rezi-create-screen/SKILL.md, .claude/skills/rezi-routing/SKILL.md, .codex/skills/rezi-routing/SKILL.md
Updated template references from animation-lab/ to starship/, changed example screen root from ui.column() to ui.page(), and renamed routing parent from dashboard to operations with corresponding child route updates (dashboard.{overview,stats}operations.{overview,logs}).
Root Documentation Consolidation
CLAUDE.md, CONTRIBUTING.md, RELEASING.md, AGENTS.md
Substantially rewritten or reduced to point readers to canonical workflows in docs/dev/. Package listings expanded, command workflows updated, and path references adjusted to match new file locations.
Developer Guides (docs/dev/)
docs/dev/releasing.md, docs/dev/repo-layout.md
Removed OSS export instructions, added gallery/ and regression-dashboard/ example entries with descriptive content.
Design & Layout Guides
docs/guide/composition.md, docs/guide/constraint-patterns.md, docs/guide/constraints.md, docs/guide/hooks-reference.md, docs/guide/input-and-focus.md, docs/guide/layout.md, docs/guide/widget-authoring.md
Removed null-return handling for ctx.useTheme() (now non-nullable), renamed "migration patterns" to "common/constraint patterns," updated terminology from "legacy" to "older/implicit," and simplified theme-aware examples.
Styling Documentation
docs/styling/defaults.md, docs/styling/focus-styles.md, docs/styling/theme.md
Renamed "Design System Defaults" to "Default Recipe Behavior," consolidated theme focus behavior (removed legacy vs ThemeDefinition distinction), and removed legacy Theme shape reference.
Widget Documentation
docs/widgets/focus-trap.md, docs/widgets/focus-zone.md, docs/widgets/stack.md
Updated example id values and terminology (e.g., trap-legacytrap-example, "legacy column" → "implicit column"), changed "backward compatibility" to "default sizing behavior".
Package API & Index
docs/packages/core.md, docs/index.md, docs/getting-started/examples.md
Updated WidgetContext.useTheme() documentation to remove null return, renamed example categories from "curated public" / "internal" to "repository" / "validation app".
Terminal & Backend Docs
docs/backend/terminal-caps.md
Minor wording: "legacy terminals" → "older terminals".
Configuration Files
.gitignore, knip.json, mkdocs.yml, package.json
Removed .claude/ and .codex/ from gitignore, removed template workspace entries for animation-lab, dashboard, stress-test in knip, updated mkdocs nav links, removed migrate:constraints-helpers npm script.
Core Rendering Logic
packages/core/src/renderer/renderToDrawlist/spacing.ts, packages/core/src/renderer/renderToDrawlist/simpleVNode.ts
Removed deprecated readIntNonNegative and readOptionalIntNonNegative aliases; updated gap calculation from readIntNonNegative to readSpacingValue.
Example Apps
examples/regression-dashboard/src/theme.ts
Updated product metadata: TEMPLATE_LABEL: "dashboard""regression", PRODUCT_TAGLINE: "Deterministic incident dashboard starter""Deterministic incident-response validation app".
Scripts & Widget Tooling
scripts/hsr/widget-demo-feedback.mjs, scripts/hsr/widget-view-self-edit.mjs, scripts/hsr/widget-view.mjs, scripts/rezi-snap.mjs, scripts/__tests__/hsr-widget-demo-feedback.test.mjs, scripts/__tests__/hsr-widget-self-edit.test.mjs
Updated fallback banner text from "placeholder" to "widget lab banner" across demo/self-edit/view modules and corresponding test assertions; removed legacy theme coercion in snapshot script.
Removed Files & Template Checks
scripts/migrate-constraints-to-helpers.mjs (removed), scripts/check-create-rezi-templates.mjs, packages/create-rezi/src/__tests__/scaffold.test.ts
Entirely removed the constraints-to-helpers migration script (~397 lines); removed animation-lab hotspot check; updated test comment terminology.
Comment Cleanup
packages/core/src/renderer/renderToDrawlist/boxBorder.ts
Removed backwards-compatibility comment for BorderStyle re-export.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Poem

🐰 hops through the starship
Legacy whispers fade to night,
Starship templates shine so bright,
Null-free themes and constraints released,
Widget lab banner's our new feast! ✨

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch repo-hygiene-cleanup

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

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

@RtlZeroMemory RtlZeroMemory marked this pull request as ready for review April 17, 2026 16:00
@RtlZeroMemory RtlZeroMemory merged commit 74771ae into main Apr 17, 2026
33 of 34 checks passed
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