Skip to content

Conversation

@babblebey
Copy link
Member

@babblebey babblebey commented Oct 4, 2025

Description

This pull request refactors and improves the local development setup flow for the project. The main changes include reorganizing setup scripts into a dedicated directory, enhancing the user interface and experience for the setup guide, and updating the setup process to use new HTML templates for instructions. These updates make the setup process clearer, more visually appealing, and easier to follow for contributors.

Setup Script Refactoring and Directory Reorganization

  • Moved and renamed the main setup script from dev/setup.js to dev/setup/index.js, and the GitHub App registration logic from dev/lib/register-github-app/index.js to dev/setup/lib/index.js, improving code organization and maintainability. [1] [2]

Enhanced Setup Guide User Interface

  • Added new HTML templates in dev/setup/lib/content.html.js for the setup guide, featuring improved styling, step-by-step instructions, and visual feedback for each setup step. This provides contributors with a clearer and more engaging setup experience.
  • Updated the setup flow to use the new HTML templates for both the start and next step pages, replacing the previous plain HTML responses with the improved guides. [1] [2]

Developer Experience Improvements

  • Updated the setup script command in package.json to use the new entry point (dev/setup/index.js), and improved the startup log message to guide users to open the correct URL in their browser. [1] [2]

Related Issue

N/A

Screenshots/Screencasts

Notes to Reviewer

N/A

@vercel
Copy link

vercel bot commented Oct 4, 2025

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

Project Deployment Preview Comments Updated (UTC)
jargons-dev Ready Ready Preview Comment Oct 19, 2025 4:16pm

💡 Enable Vercel Agent with $100 free credit for automated AI reviews

@babblebey babblebey changed the title feat(Dev/setup): implement improved contributor onboarding UI refactor(dev/setup): implement improved contributor onboarding UI Oct 19, 2025
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.

2 participants