Prune Screen union, document Helio props, and add testing/CHANGELOG docs - #492
Conversation
The Screen union and its onNav(screen) pattern predate the App Router migration and had no consumers left in the codebase — 'how' and 'learn' were never real routes, and 'project' (the click-through's actual detail step) was missing entirely. Rewrite it to mirror the investor click-through's real top-level routes under src/app, with each member commented against its route. Closes Heliobond#374
Expand the JSDoc on Helio, HelioWebGL, and LiveHelio so the API is documented in one discoverable place instead of scattered/implicit comments: - HelioProps / HelioWebGLProps: document every prop, including exactly what `intensity` drives (resting scale, emissive brightness, halo opacity) and that `breathe` is independent of the CSS-level prefers-reduced-motion override in app.css. - LiveHelio: document the static-to-live cross-fade sequence (static orb visible until HelioWebGL's onReady fires, then 600ms fade) and the reduced-motion / no-WebGL fallback (canvas never paints, so the static orb simply remains). Closes Heliobond#379
Expand the "Running tests" section into "Testing", adding the structure (co-located *.test.ts(x) next to source, src/__tests__/ for cross-cutting cases, e2e/ as one *.spec.ts per flow) and helper conventions (src/test/render.tsx for Vitest, the demo-wallet seeding pattern for Playwright) so new tests follow the same pattern the existing suite already uses, on top of the run instructions that were already documented. Closes Heliobond#377
Add CHANGELOG.md (Keep a Changelog format), seeded with an Unreleased section summarizing the app's recent notable changes, and document in CONTRIBUTING.md's development workflow when and how contributors add an entry for their own PR. Closes Heliobond#378
|
@devsimze Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
@devsimze is attempting to deploy a commit to the David Dada's projects Team on Vercel. A member of the Team first needs to authorize it. |
sshdopey
left a comment
sshdopey
left a comment
There was a problem hiding this comment.
This is a thoughtful, well-scoped PR that addresses all four linked issues with clear documentation and a sensible type cleanup. The CHANGELOG and testing docs are thorough and will genuinely help contributors, and the Helio prop docs are detailed and accurate. The Screen union update correctly reflects the real routes. Great work bundling these small, independent changes with clear commit messages. Thanks for the effort! ❤️
2 participants
Summary
Four small, independent fixes/docs changes bundled into one PR (four commits, one per issue):
src/types.ts'sScreenunion and itsonNav(screen)pattern had zero consumers left in the codebase (superseded by the App Router'suseRouter().push(...)/<Link>). Rewrote the union to mirror the investor click-through's real top-level routes (landing → connect → explore → project → deposit → portfolio → withdraw, per README.md), dropping non-route members (how,learn) and adding the missingprojectstep.Helio,HelioWebGL, andLiveHelioso the prop API (motes,intensity,breathe), the static-to-live cross-fade sequence, and the reduced-motion / no-WebGL fallback behaviour are documented in one place per component.*.test.ts(x),src/__tests__/for cross-cutting cases,e2e/*.spec.tsper flow) and helper conventions (src/test/render.tsx, the demo-wallet seeding pattern), on top of the existing run instructions.CHANGELOG.md(Keep a Changelog format) seeded with anUnreleasedsection, and documented in CONTRIBUTING.md's workflow when/how contributors add an entry for their own PR.Linked issues
Closes #374
Closes #377
Closes #378
Closes #379
Type of change
Screenshots / screencast
Not applicable — no UI changes, docs and a dead-code type cleanup only.
Checklist
Closes #374,#377,#378,#379)bun run buildpasses locally — not run: this environment doesn't havebuninstalled and disk space is extremely constrained, so I didn't install dependencies. All changes are comment/doc-only or a type-only union edit with no existing consumers, reviewed by hand for syntax correctness; happy to run the full check if a maintainer would rather I set that up.🤖 Generated with Claude Code