docs: replace boilerplate README with project-specific documentation - #1
Merged
Conversation
Copilot created this pull request from a session on behalf of
Brunoiooo
July 8, 2026 12:17
View session
Brunoiooo
marked this pull request as ready for review
July 8, 2026 12:17
There was a problem hiding this comment.
Pull request overview
Replaces the default create-next-app README with project-specific documentation describing “Job Finder” (an AI-assisted Useme job application pipeline), how to configure it, and how to operate the dashboard.
Changes:
- Adds a project overview, feature list, and tech stack summary.
- Documents environment variables and initial setup steps (including Prisma/DB setup).
- Explains dashboard workflow, project structure, scripts, and Prisma models at a high level.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was the default
create-next-apptemplate — useless for anyone trying to understand or run the project.Changes
.env.exampledocumented), DB migration steps/promptspageactions/,services/,components/