Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/resume-analyzer/llms.txt

Use this file to discover all available pages before exploring further.

The Resume Check Karo dashboard is your primary workspace. From here you fill in the details of the role you are targeting, upload your resume PDF, trigger the AI analysis, and read the resulting feedback report — all within a single, focused interface that lives at /dashboard.

Getting to the Dashboard

The dashboard is a protected route. You must be signed in with your Clerk account before you can access it.
1

Click 'Get Started'

From any page, click the Get Started button in the navigation bar. The navbar is fixed at the top of every page and links directly to /dashboard.
2

Sign In

If you are not already authenticated, Clerk will present the sign-in flow. After successful authentication you are redirected to /dashboard.
3

You're on the Dashboard

The upload form is displayed inside a centered max-w-5xl container. You are ready to start your analysis.
Navigating directly to /dashboard while signed out will redirect you to the Clerk authentication screen. Bookmark the URL — you will be brought straight to the dashboard after signing in.

The Upload Form

The form collects four pieces of information before an analysis can be run. All fields are required.

Company Name

The name of the employer you are applying to. This is injected into the AI prompt so the model can tailor its feedback to the company’s context.

Job Title

The exact title of the role (e.g., “Senior Software Engineer”, “Product Manager”). This helps the model calibrate expected seniority and skill requirements.

Job Description

The full text of the job posting. Must be at least 50 characters. For the best results, paste the complete description — 150 words or more gives the model enough signal for targeted, role-specific feedback.

Resume File

Your resume in PDF format, maximum 10 MB. Click the upload input or use the file picker to select your resume.

Client-Side Validation

The form validates your inputs before making any server request. Submitting with incomplete or invalid fields displays inline error messages without sending anything to the server.
FieldRule
Company NameRequired — cannot be empty
Job TitleRequired — cannot be empty
Job DescriptionRequired, minimum 50 characters
Resume FileRequired, PDF/DOC/DOCX accepted by the picker, max 10 MB
The file picker accepts PDF, DOC, and DOCX for convenience, but the server action enforces PDF only. Upload a .pdf file to avoid a server-side error after submission.

File Upload

The resume field uses a standard file input. Click the upload button to open your operating system’s file picker and select your resume file. Once a file is selected, its name and size are displayed below the input. You can replace the file at any time before submitting by clicking the input again to select a different file.

Analysis Flow States

After you submit the form, the dashboard moves through three distinct states:
1

Form View

The default state. The upload form is visible and all four fields are editable. The Analyze Resume button submits the form.
2

Processing

Immediately after submission, the form is replaced by a loading animation and a status message while the analyzeResume server action validates your inputs, builds the AI prompt, and waits for the Gemini response. This typically takes a few seconds.
3

Feedback View

Once the AI response is parsed, the loading animation is replaced by the FeedbackDisplay component, which renders your full scorecard with the overall score, five category cards, animated progress bars, and color-coded tips.

After Analysis

When the feedback report is on screen you can:
  • Review your scores — read each category card, check your score badges, and scan the animated progress bars for a visual summary
  • Act on tips — work through the red “improve” tips, prioritizing those with explanations
  • Analyze another resume — click the Analyze Another Resume button at the bottom of the report to reset the file, feedback, and error state and return to the upload form
See the Feedback Display page for a full guide to reading and acting on your report.

Build docs developers (and LLMs) love