Add project assets and update dependencies by michellepace · Pull Request #2 · michellepace/devflow

michellepace · 2025-12-01T13:33:40Z

Summary

Add public assets: 48 SVG icons and 9 images (logos, auth backgrounds, illustrations)
Add Figma design references for all pages (light/dark variants)
Add documentation: textbook notes for auth and state management
Update dependencies: Next.js 16.0.6, Vercel analytics/speed-insights
Configure Biome 2.3.8 with stricter lint settings

Test plan

All unit tests pass
All E2E tests pass (Chromium + Mobile Safari)
Lint and typecheck pass

🤖 Generated with Claude Code

Public Assets: - Add 48 SVG icons (navigation, actions, social, medals, UI elements) - Add logo variants, auth backgrounds, and page illustrations Figma Designs: - Add design system files (colours, typography, component overview) - Add page mockups for home, profile, search, Q&A (light/dark variants) - Add auth screens and mobile navigation screenshots Documentation: - Add textbook notes for auth and state management - Add colours reference - Remove placeholder images Dependencies: - Update next 16.0.5 → 16.0.6 - Update @vercel/analytics 1.5.0 → 1.6.0 - Update @vercel/speed-insights 1.2.0 → 1.3.0 Config: - Update Biome schema to 2.3.8, exclude x_docs/reference from linting - Add --error-on-warnings to lint script for local/CI parity Sets up project with UI assets from Figma designs and brings dependencies to current versions. Lint strictness ensures local checks match CI behaviour. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

vercel · 2025-12-01T13:33:45Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
devflow	Ready	Preview	Comment	Dec 1, 2025 1:33pm

coderabbitai · 2025-12-01T13:33:48Z

Summary by CodeRabbit

Documentation
- Restructured README with improved organisation and technology stack details
- Added comprehensive guides on authentication methods, HTTP state management, and design colour variables
Chores
- Updated dependencies: Vercel Analytics, Vercel Speed Insights, and Next.js
- Enhanced linting to treat warnings as errors
- Updated tool configuration with expanded exclusions

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

Walkthrough

Project documentation and configuration refined across multiple files. README restructured to prioritise tooling descriptions over procedural steps, biome schema updated, package dependencies bumped for analytics and Next.js, and three new technical documentation guides added covering colour variables, authentication types, and state management patterns.

Changes

Cohort / File(s)	Summary
Configuration Updates `biome.json`, `package.json`	Biome schema version bumped to 2.3.8 with expanded file exclusions; lint script now treats warnings as errors (`--error-on-warnings`); dependency versions updated for `@vercel/analytics` (^1.6.0), `@vercel/speed-insights` (^1.3.0), and `next` (^16.0.6)
Documentation Reorganisation `README.md`	Hero tagline replaced with community-driven platform focus; "Use This Template" onboarding steps removed; technology stack converted from minimal list to detailed table; installation narrative replaced with package.json reference; config files section replaced with comprehensive table; CI/CD workflow narrative and ASCII diagram removed
New Technical Documentation `x_docs/own/colours.md`, `x_docs/textbook/auth.md`, `x_docs/textbook/state.md`	Added colour variables mapping documentation; added authentication types guide covering session-based, token-based (JWT), OAuth, and Basic auth; added HTTP state management guide covering cookies, localStorage, sessionStorage, IndexedDB, and Zustand patterns

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

README restructuring, whilst substantial, remains documentation-only with no logic changes
Configuration updates are straightforward version bumps and single flag additions
New documentation files are informational additions without code implications
No complex interdependencies or logic density requiring deeper scrutiny

Possibly related PRs

Bump the npm-dependencies group with 2 updates #1 — Performs overlapping README cleanup and removal of template boilerplate documentation with the same structural intent.
Add project assets and update dependencies #2 — Modifies identical files (biome.json, package.json) and adds the same new documentation file (x_docs/own/colours.md).

Poem

🐰 The warren of docs now gleams so bright,
With colours charted and auth set right,
State flows clean through tab and store,
Config refined to hurt no more.
Linting stern, biome won't stray—
The platform blooms a better way!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarises the main changes: adding project assets (SVGs, images, documentation) and updating dependencies, which aligns with the changeset modifications across README, config files, and new documentation files.
Description check	✅ Passed	The description is directly related to the changeset, detailing the addition of assets, documentation, and dependency updates that correspond to the files modified in the pull request.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch setup/devflow-assets

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7813b15 and 9f3f25e.

⛔ Files ignored due to path filters (81)

package-lock.json is excluded by !**/package-lock.json
public/icons/account.svg is excluded by !**/*.svg
public/icons/arrow-left.svg is excluded by !**/*.svg
public/icons/arrow-right.svg is excluded by !**/*.svg
public/icons/arrow-up-right.svg is excluded by !**/*.svg
public/icons/au.svg is excluded by !**/*.svg
public/icons/avatar.svg is excluded by !**/*.svg
public/icons/bronze-medal.svg is excluded by !**/*.svg
public/icons/calendar.svg is excluded by !**/*.svg
public/icons/carbon-location.svg is excluded by !**/*.svg
public/icons/chevron-down.svg is excluded by !**/*.svg
public/icons/chevron-right.svg is excluded by !**/*.svg
public/icons/clock-2.svg is excluded by !**/*.svg
public/icons/clock.svg is excluded by !**/*.svg
public/icons/close.svg is excluded by !**/*.svg
public/icons/computer.svg is excluded by !**/*.svg
public/icons/currency-dollar-circle.svg is excluded by !**/*.svg
public/icons/downvote.svg is excluded by !**/*.svg
public/icons/downvoted.svg is excluded by !**/*.svg
public/icons/edit.svg is excluded by !**/*.svg
public/icons/eye.svg is excluded by !**/*.svg
public/icons/github.svg is excluded by !**/*.svg
public/icons/gold-medal.svg is excluded by !**/*.svg
public/icons/google.svg is excluded by !**/*.svg
public/icons/hamburger.svg is excluded by !**/*.svg
public/icons/home.svg is excluded by !**/*.svg
public/icons/job-search.svg is excluded by !**/*.svg
public/icons/like.svg is excluded by !**/*.svg
public/icons/link.svg is excluded by !**/*.svg
public/icons/location.svg is excluded by !**/*.svg
public/icons/message.svg is excluded by !**/*.svg
public/icons/mingcute-down-line.svg is excluded by !**/*.svg
public/icons/moon.svg is excluded by !**/*.svg
public/icons/question.svg is excluded by !**/*.svg
public/icons/search.svg is excluded by !**/*.svg
public/icons/sign-up.svg is excluded by !**/*.svg
public/icons/silver-medal.svg is excluded by !**/*.svg
public/icons/star-filled.svg is excluded by !**/*.svg
public/icons/star-red.svg is excluded by !**/*.svg
public/icons/star.svg is excluded by !**/*.svg
public/icons/stars.svg is excluded by !**/*.svg
public/icons/suitcase.svg is excluded by !**/*.svg
public/icons/sun.svg is excluded by !**/*.svg
public/icons/tag.svg is excluded by !**/*.svg
public/icons/trash.svg is excluded by !**/*.svg
public/icons/upvote.svg is excluded by !**/*.svg
public/icons/upvoted.svg is excluded by !**/*.svg
public/icons/user.svg is excluded by !**/*.svg
public/icons/users.svg is excluded by !**/*.svg
public/images/dark-illustration.png is excluded by !**/*.png
public/images/default-logo.svg is excluded by !**/*.svg
public/images/light-illustration.png is excluded by !**/*.png
public/images/logo-dark.svg is excluded by !**/*.svg
public/images/logo-light.svg is excluded by !**/*.svg
public/images/logo.png is excluded by !**/*.png
public/images/site-logo.svg is excluded by !**/*.svg
x_docs/figma/_all.png is excluded by !**/*.png
x_docs/figma/_colors.png is excluded by !**/*.png
x_docs/figma/_typography.png is excluded by !**/*.png
x_docs/figma/auth/signin1-dark.jpg is excluded by !**/*.jpg
x_docs/figma/auth/signin1-light.jpg is excluded by !**/*.jpg
x_docs/figma/auth/signin2-dark.jpg is excluded by !**/*.jpg
x_docs/figma/auth/signin2-light.jpg is excluded by !**/*.jpg
x_docs/figma/auth/signup-dark.jpg is excluded by !**/*.jpg
x_docs/figma/auth/signup-light.jpg is excluded by !**/*.jpg
x_docs/figma/bg-dark.jpg is excluded by !**/*.jpg
x_docs/figma/bg-light.jpg is excluded by !**/*.jpg
x_docs/figma/home_dark.png is excluded by !**/*.png
x_docs/figma/home_light.png is excluded by !**/*.png
x_docs/figma/mobile/nav-closed__dark.png is excluded by !**/*.png
x_docs/figma/mobile/nav-closed__light.png is excluded by !**/*.png
x_docs/figma/mobile/nav-open_dark.png is excluded by !**/*.png
x_docs/figma/mobile/nav-open_light.png is excluded by !**/*.png
x_docs/figma/profile_dark.png is excluded by !**/*.png
x_docs/figma/profile_light.png is excluded by !**/*.png
x_docs/figma/qna_dark.png is excluded by !**/*.png
x_docs/figma/qna_light.png is excluded by !**/*.png
x_docs/figma/search_dark.png is excluded by !**/*.png
x_docs/figma/search_light.png is excluded by !**/*.png
x_docs/images/explained.jpg is excluded by !**/*.jpg
x_docs/images/rough.jpg is excluded by !**/*.jpg

📒 Files selected for processing (6)

README.md (3 hunks)
biome.json (2 hunks)
package.json (2 hunks)
x_docs/own/colours.md (1 hunks)
x_docs/textbook/auth.md (1 hunks)
x_docs/textbook/state.md (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: CR
Repo: michellepace/devflow PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-30T01:23:02.495Z
Learning: Use Biome for linting and formatting (replaces ESLint and Prettier) - run 'npm run check' for linting and type checking

📚 Learning: 2025-11-30T01:23:02.495Z

Learnt from: CR
Repo: michellepace/devflow PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-30T01:23:02.495Z
Learning: Use Biome for linting and formatting (replaces ESLint and Prettier) - run 'npm run check' for linting and type checking

Applied to files:

package.json
biome.json

📚 Learning: 2025-11-30T01:23:02.495Z

Learnt from: CR
Repo: michellepace/devflow PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-30T01:23:02.495Z
Learning: Applies to **/*.{css,scss} : Use Tailwind CSS v4 with 'import "tailwindcss"' syntax in CSS files (not the legacy 'tailwind' directives)

Applied to files:

biome.json

🪛 LanguageTool

README.md

[uncategorized] ~26-~26: Possible missing comma found.
Context: ...alytics viewable on Vercel | For exact list see package.json ## ⚙️...

(AI_HYDRA_LEO_MISSING_COMMA)

x_docs/textbook/auth.md

[uncategorized] ~104-~104: Possible missing comma found.
Context: ...sing basic authentication for sensitive applications as credentials are sent with every requ...

(AI_HYDRA_LEO_MISSING_COMMA)

x_docs/textbook/state.md

[uncategorized] ~34-~34: Loose punctuation mark.
Context: ...s. Security Features: - HttpOnly: Prevents JavaScript access, protecting ...

(UNLIKELY_OPENING_PUNCTUATION)

[grammar] ~77-~77: Did you mean “does Not automatically sent with request”?
Context: ...acks** - Any JavaScript can access it - Not automatically sent with requests - Synchronous operations can block UI t...

(PRP_NOT_VB)

[misspelling] ~91-~91: This word is normally spelled as one.
Context: ... tab/window. General Use Cases: - Multi-step form data - Temporary shopping cart sta...

(EN_COMPOUNDS_MULTI_STEP)

🔇 Additional comments (8)

biome.json (1)

2-2: Configuration changes are well-aligned with project structure.

The schema version bump to 2.3.8 matches your updated Biome dependency, and the exclusion of !x_docs/reference appropriately manages the expanded documentation whilst avoiding unnecessary linting overhead.

Also applies to: 11-18

x_docs/own/colours.md (1)

1-76: Well-organised colour reference documentation.

The colour variable mappings from Figma are clearly structured with separate tables for core and sidebar colours. The palette reference and step-by-step instructions provide helpful guidance for maintaining colour consistency across light and dark modes.

x_docs/textbook/auth.md (1)

1-106: Comprehensive authentication types reference.

The documentation effectively explains four authentication approaches with clear workflows, trade-offs, and security considerations. The warning for basic authentication appropriately emphasises the security risks. This guide will help developers make informed choices about authentication strategies.

package.json (2)

9-9: Lint script now enforces stricter error handling.

The addition of --error-on-warnings flag will catch more issues during development. This aligns with the project's quality standards and the expanded Biome configuration. Ensure your CI/CD pipeline and local development workflows account for this stricter enforcement.

25-27: These dependency versions are compatible. Next.js 16 was designed to support React 19, and both @vercel/analytics 1.6.0 and @vercel/speed-insights 1.3.0 support Next.js 16 with React 19. With all tests passing, this upgrade is safe.

x_docs/textbook/state.md (1)

1-237: Excellent state management and security best practices guide.

This documentation comprehensively covers client-side storage mechanisms with clear guidance on security best practices. The hybrid approach (HTTP-only refresh tokens + memory-stored access tokens) and the 10-key security principles provide valuable guidance for authentication implementation. The quick reference table effectively summarises the trade-offs.

README.md (2)

9-26: Technology stack table enhances readability.

The restructured "What's Installed?" section now uses a clear table format that makes the tooling stack immediately scannable. The categories (Language, Styling, Linting, Testing, etc.) effectively organise the information for quick reference.

30-55: Config Files table provides comprehensive reference.

Converting the "Config Files Explained" section to a table format with emoji categorisation (🅽, 🧪, 🚀, etc.) makes the configuration landscape much easier to navigate. The descriptions are concise and actionable for developers exploring the project structure.

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.}

vercel bot deployed to Preview December 1, 2025 13:33 View deployment

michellepace merged commit cec8c26 into main Dec 1, 2025
7 checks passed

michellepace deleted the setup/devflow-assets branch December 1, 2025 13:45

michellepace mentioned this pull request Dec 1, 2025

Bump the npm-dependencies group with 2 updates #1

Closed

This was referenced Dec 2, 2025

Template cleanup and course alignment #3

Merged

feature: add navbar with shadcn/ui theming #4

Merged

coderabbitai bot mentioned this pull request Dec 10, 2025

feat: add Clerk authentication with E2E tests #7

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add project assets and update dependencies#2

Add project assets and update dependencies#2
michellepace merged 1 commit intomainfrom
setup/devflow-assets

michellepace commented Dec 1, 2025

Uh oh!

vercel bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

michellepace commented Dec 1, 2025

Summary

Test plan

Uh oh!

vercel bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel bot commented Dec 1, 2025 •

edited

Loading

coderabbitai bot commented Dec 1, 2025 •

edited

Loading