mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-07-14 23:07:01 +10:00
docs: enhance documentation and guides with new features and updates
This commit is contained in:
Amruth Pillai
@@ -52,11 +52,15 @@
|
||||
"group": "Resume Builder",
|
||||
"pages": [
|
||||
"guides/creating-your-first-resume",
|
||||
"guides/managing-resumes-from-the-dashboard",
|
||||
"guides/importing-resumes",
|
||||
"guides/choosing-a-template",
|
||||
"guides/selecting-page-format",
|
||||
"guides/moving-items-between-sections",
|
||||
"guides/fitting-content-on-a-page",
|
||||
"guides/adding-a-cover-letter",
|
||||
"guides/using-the-builder-dock",
|
||||
"guides/using-ai-in-the-builder",
|
||||
"guides/exporting-your-resume",
|
||||
"guides/sharing-your-resume-publicly",
|
||||
"guides/using-private-notes"
|
||||
|
||||
@@ -17,20 +17,27 @@ description: "Learn how to create your first resume in Reactive Resume, set a na
|
||||
After logging in, navigate to your Dashboard where all of your resumes live.
|
||||
|
||||
<Info>
|
||||
This is where you can create, organize, and manage multiple resumes for different roles or versions.
|
||||
This is where you can create, import, organize, and manage multiple resumes for different roles or versions.
|
||||
</Info>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Click “Create a new resume”">
|
||||
In the Resumes Dashboard, click on the <Badge>Create a new resume</Badge> card to open the creation form.
|
||||
|
||||
<Frame caption="Create a new resume dialog">
|
||||
<img
|
||||
src="/images/guides/creating-your-first-resume/screenshot-1.png"
|
||||
alt="Create a new resume dialog with name, slug, and tags fields"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Name your resume">
|
||||
Fill in the resume name. This can be a generic name (e.g., “General Resume”) or something tied to the position you’re applying for.
|
||||
|
||||
<Tip>
|
||||
If you can’t think of a name yet, click the <Badge>Magic Wand</Badge> button to generate a random name for you.
|
||||
If you can’t think of a name yet, click the magic wand button to generate a random name for you.
|
||||
</Tip>
|
||||
|
||||
</Step>
|
||||
@@ -48,12 +55,31 @@ description: "Learn how to create your first resume in Reactive Resume, set a na
|
||||
Add any <Badge>Tags</Badge> you want. Think of tags like folders or labels to help organize many resumes.
|
||||
|
||||
<Info>
|
||||
You can filter resumes by tags later from the Dashboard.
|
||||
You can filter resumes by tags later from the Dashboard. The tag filter appears after you have at least one tag.
|
||||
</Info>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Choose a blank or sample resume">
|
||||
Click **Create** to start with an empty resume, or open the split-button menu and choose **Create a Sample Resume** to start with sample content.
|
||||
|
||||
<Tip>
|
||||
A sample resume is useful when you want to explore templates, layout controls, and exports before entering your own
|
||||
information.
|
||||
</Tip>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Open the resume in the builder">
|
||||
Once created, a new card for your resume will appear on the Dashboard. Click it to open the resume builder and start editing.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## What you can do next
|
||||
|
||||
After creating your first resume, you can:
|
||||
|
||||
- change the template in [Choosing a template](/guides/choosing-a-template);
|
||||
- adjust the page format in [Selecting the right page format](/guides/selecting-page-format);
|
||||
- download a copy in [Exporting your resume](/guides/exporting-your-resume);
|
||||
- organize, duplicate, lock, or delete resumes in [Managing resumes from the dashboard](/guides/managing-resumes-from-the-dashboard).
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: "Importing resumes"
|
||||
description: "Learn which file formats Reactive Resume can import and how to import an existing resume from the dashboard."
|
||||
---
|
||||
|
||||
Reactive Resume can create a new resume from several existing file formats. Use import when you are moving from another tool, restoring a backup, or converting an older Reactive Resume file.
|
||||
|
||||
## Supported import formats
|
||||
|
||||
| Format | Requires AI integration? | Notes |
|
||||
| --- | --- | --- |
|
||||
| **Reactive Resume (JSON)** | No | Best option for backups exported from the current version of Reactive Resume. |
|
||||
| **Reactive Resume v4 (JSON)** | No | Use this for files exported from Reactive Resume v4. |
|
||||
| **JSON Resume** | No | Use this for files that follow the JSON Resume schema. |
|
||||
| **PDF** | Yes | Reactive Resume asks your configured AI provider to parse the file into structured resume data. |
|
||||
| **Microsoft Word** | Yes | Supports Word documents. Reactive Resume asks your configured AI provider to parse the document. |
|
||||
|
||||
<Info>
|
||||
PDF and Word imports depend on your AI settings because those formats are not structured resume data. Configure AI in
|
||||
**Dashboard -> Settings -> Integrations** before using those import types.
|
||||
</Info>
|
||||
|
||||
## Import a resume
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the Resumes dashboard">
|
||||
Sign in and go to **Dashboard -> Resumes**.
|
||||
</Step>
|
||||
|
||||
<Step title="Click Import an existing resume">
|
||||
Select the **Import an existing resume** card.
|
||||
|
||||
<Frame caption="Import an existing resume dialog">
|
||||
<img
|
||||
src="/images/guides/importing-resumes/screenshot-1.png"
|
||||
alt="Import dialog showing supported resume import types"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Choose the import type">
|
||||
Pick the format that matches your file.
|
||||
</Step>
|
||||
|
||||
<Step title="Select the file">
|
||||
Click the file selector and choose the resume file from your computer.
|
||||
</Step>
|
||||
|
||||
<Step title="Import">
|
||||
Click **Import**. Reactive Resume creates a new resume and opens it in the builder when the import succeeds.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Choose the right import type
|
||||
|
||||
If you have a file exported from Reactive Resume, choose **Reactive Resume (JSON)**. This preserves the most information because the file already matches Reactive Resume's data model.
|
||||
|
||||
If you are coming from Reactive Resume v4, choose **Reactive Resume v4 (JSON)**.
|
||||
|
||||
If your file is a standard JSON Resume document, choose **JSON Resume**.
|
||||
|
||||
If you only have a PDF or Word document, choose **PDF** or **Microsoft Word**. After import, review every section carefully. AI parsing can save time, but it can also miss details, change wording, or place content in the wrong section.
|
||||
|
||||
<Warning>
|
||||
Always review an imported resume before sharing or exporting it. This is especially important for PDF and Word imports.
|
||||
</Warning>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### The PDF or Word import says AI must be enabled
|
||||
|
||||
Open **Dashboard -> Settings -> Integrations**, fill in your AI provider settings, test the connection, and enable AI features.
|
||||
|
||||
### The imported resume is incomplete
|
||||
|
||||
Try importing a cleaner source file. Simple resumes with selectable text import more reliably than scanned documents, image-heavy PDFs, or files with complex tables.
|
||||
|
||||
### The JSON file is rejected
|
||||
|
||||
Make sure you selected the correct JSON import type. A Reactive Resume JSON export, a Reactive Resume v4 JSON export, and a JSON Resume file are different formats.
|
||||
@@ -0,0 +1,113 @@
|
||||
---
|
||||
title: "Managing resumes from the dashboard"
|
||||
description: "Learn how to sort, filter, open, duplicate, lock, update, and delete resumes from the Resumes dashboard."
|
||||
---
|
||||
|
||||
The **Resumes** dashboard is where you manage every resume in your account. Use it to keep separate versions for different roles, clients, locations, or application stages.
|
||||
|
||||
<Frame caption="Resumes dashboard in grid view">
|
||||
<img
|
||||
src="/images/guides/managing-resumes-from-the-dashboard/screenshot-1.png"
|
||||
alt="Resumes dashboard showing sort controls, grid view, create and import cards, and a sample resume"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
## Choose a view
|
||||
|
||||
The dashboard supports two views:
|
||||
|
||||
- **Grid** shows each resume as a card. This is useful when you want a visual overview.
|
||||
- **List** shows resumes in rows. This is useful when you have many resumes and want a denser view.
|
||||
|
||||
Use the **Grid** and **List** tabs in the top-right of the dashboard to switch between them.
|
||||
|
||||
<Frame caption="Resumes dashboard in list view">
|
||||
<img
|
||||
src="/images/guides/managing-resumes-from-the-dashboard/screenshot-2.png"
|
||||
alt="Resumes dashboard showing the same resume in list view"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
## Sort resumes
|
||||
|
||||
Use the **Sort by** menu to change the order of your resumes.
|
||||
|
||||
| Sort option | When to use it |
|
||||
| --- | --- |
|
||||
| **Last Updated** | Find the resume you worked on most recently. |
|
||||
| **Created** | Review resumes by when they were first created. |
|
||||
| **Name** | Keep resumes in alphabetical order. |
|
||||
|
||||
## Filter by tags
|
||||
|
||||
If you add tags to your resumes, the dashboard shows a **Filter by** menu. Select one or more tags to show only matching resumes.
|
||||
|
||||
Tags are useful for grouping resumes by:
|
||||
|
||||
- target role, such as `frontend` or `product`;
|
||||
- application status, such as `draft` or `sent`;
|
||||
- market, region, client, or company name.
|
||||
|
||||
<Tip>
|
||||
You can add or change tags when creating, updating, or duplicating a resume.
|
||||
</Tip>
|
||||
|
||||
## Open a resume
|
||||
|
||||
Click a resume card or row to open it in the builder.
|
||||
|
||||
You can also open the resume menu and choose **Open**.
|
||||
|
||||
## Update name, slug, and tags
|
||||
|
||||
Use **Update** when you want to change a resume's metadata.
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the resume menu">
|
||||
On the dashboard, open the menu for the resume you want to edit.
|
||||
</Step>
|
||||
|
||||
<Step title="Choose Update">
|
||||
Select **Update** to open the resume details dialog.
|
||||
</Step>
|
||||
|
||||
<Step title="Edit the fields">
|
||||
Change the **Name**, **Slug**, or **Tags**.
|
||||
</Step>
|
||||
|
||||
<Step title="Save changes">
|
||||
Click **Save Changes**.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Warning>
|
||||
The slug is part of the public URL. If a resume is public, changing the slug changes the link people use to view it.
|
||||
</Warning>
|
||||
|
||||
## Duplicate a resume
|
||||
|
||||
Use **Duplicate** when you want to create a new version without changing the original.
|
||||
|
||||
The duplicate dialog starts with the same tags, a copied name, and a copied slug. Edit these before saving if you want the new version to be easier to identify.
|
||||
|
||||
Good reasons to duplicate a resume:
|
||||
|
||||
- tailoring one resume for a specific job posting;
|
||||
- keeping a short and long version;
|
||||
- testing a new template or layout;
|
||||
- creating a localized version.
|
||||
|
||||
## Lock or unlock a resume
|
||||
|
||||
Use **Lock** to prevent accidental edits or deletion. A locked resume cannot be updated or deleted until you unlock it.
|
||||
|
||||
To edit a locked resume later, open the resume menu and choose **Unlock**.
|
||||
|
||||
## Delete a resume
|
||||
|
||||
Use **Delete** only when you no longer need the resume.
|
||||
|
||||
<Warning>
|
||||
Deleting a resume cannot be undone. If you might need the content later, export a JSON backup first. See
|
||||
[Exporting your resume](/guides/exporting-your-resume).
|
||||
</Warning>
|
||||
@@ -107,8 +107,6 @@ A common use case is when your work history is too long to fit on a single page.
|
||||
- Page 2 continues with your earlier experience
|
||||
- The section headings and styling remain consistent
|
||||
|
||||
{/* TODO: Add screenshot showing a resume with Experience split across page 1 and page 2 */}
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Sharing your resume publicly"
|
||||
description: "Learn how to share your resume via a public URL, track views and downloads, and optionally protect your resume with a password."
|
||||
description: "Learn how to share your resume via a public URL, track public engagement, and optionally protect your resume with a password."
|
||||
---
|
||||
|
||||
Reactive Resume lets you share your resume via a **public URL** that anyone can access. When you make your resume public, it becomes available at a unique link that you can share with recruiters, include in your portfolio, or add to your LinkedIn profile.
|
||||
@@ -12,7 +12,7 @@ Reactive Resume lets you share your resume via a **public URL** that anyone can
|
||||
Viewers always see the latest version of your resume. No need to send new files when you make updates.
|
||||
</Card>
|
||||
<Card title="Track engagement" icon="chart-line">
|
||||
See how many times your resume has been viewed and downloaded.
|
||||
See public engagement counters in the builder.
|
||||
</Card>
|
||||
<Card title="Password protection" icon="lock">
|
||||
Optionally require a password so only people you trust can access your resume.
|
||||
@@ -33,6 +33,13 @@ Reactive Resume lets you share your resume via a **public URL** that anyone can
|
||||
|
||||
<Step title="Toggle 'Allow Public Access'">
|
||||
Turn on the **Allow Public Access** switch. Once enabled, your resume will be accessible via its public URL.
|
||||
|
||||
<Frame caption="Sharing section in the resume builder">
|
||||
<img
|
||||
src="/images/guides/sharing-your-resume-publicly/screenshot-1.png"
|
||||
alt="Sharing section showing the public access control"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Copy your public URL">
|
||||
@@ -58,7 +65,7 @@ When someone visits your public resume URL:
|
||||
|
||||
1. **They see the live version** - The page renders your current resume data with all your latest changes
|
||||
2. **No account required** - Visitors don't need a Reactive Resume account to view or download your resume
|
||||
3. **They can print or save as PDF** - Visitors can use their browser's print function to save a PDF copy
|
||||
3. **They can download a PDF** - Visitors can use the download button on the public page
|
||||
4. **Views are tracked** - Each visit is counted in your resume statistics (see below)
|
||||
|
||||
<Info>
|
||||
@@ -66,9 +73,9 @@ When someone visits your public resume URL:
|
||||
public resume is always in sync.
|
||||
</Info>
|
||||
|
||||
## Tracking views and downloads
|
||||
## Tracking public engagement
|
||||
|
||||
When your resume is public, Reactive Resume tracks how many times it has been viewed and downloaded. This helps you understand engagement and see if people are actually looking at your resume.
|
||||
When your resume is public, Reactive Resume tracks public views. This helps you understand whether people are opening the link you shared.
|
||||
|
||||
### Where to find statistics
|
||||
|
||||
@@ -80,12 +87,12 @@ You'll see:
|
||||
| ------------------- | ---------------------------------------------------------------- |
|
||||
| **Views** | Number of times your public resume page was visited |
|
||||
| **Last viewed** | The date when your resume was last viewed |
|
||||
| **Downloads** | Number of times your resume was downloaded (via the public page) |
|
||||
| **Last downloaded** | The date when your resume was last downloaded |
|
||||
| **Downloads** | Number of recorded resume downloads |
|
||||
| **Last downloaded** | The date when the last recorded download happened |
|
||||
|
||||
<Info>
|
||||
Statistics are only tracked when your resume is **public**. If you turn off public access, tracking pauses but your
|
||||
existing stats are preserved.
|
||||
Statistics are only shown after public sharing is enabled. If you turn off public access, existing stats are
|
||||
preserved.
|
||||
</Info>
|
||||
|
||||
### What counts as a view?
|
||||
@@ -118,7 +125,7 @@ When password protection is enabled:
|
||||
First, make sure **Allow Public Access** is turned on in the **Sharing** section.
|
||||
</Step>
|
||||
|
||||
<Step title="Click 'Set Password'">Below the public URL, click the **Set Password** button.</Step>
|
||||
<Step title="Click Set Password">Below the public URL, click **Set Password**.</Step>
|
||||
|
||||
<Step title="Enter your password">
|
||||
Type a password (6-64 characters) and confirm. This password will be required to view your resume.
|
||||
@@ -190,6 +197,15 @@ When public access is disabled:
|
||||
access entirely. This way, your URL remains active for people who have the password.
|
||||
</Tip>
|
||||
|
||||
## Copying the URL from the builder dock
|
||||
|
||||
The builder dock includes a **Copy URL** shortcut. It copies the same public URL shown in the **Sharing** section.
|
||||
|
||||
<Warning>
|
||||
Copying the URL does not enable public access. Turn on **Allow Public Access** in the **Sharing** section before sending
|
||||
the link to someone else.
|
||||
</Warning>
|
||||
|
||||
## Frequently asked questions
|
||||
|
||||
<AccordionGroup>
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
---
|
||||
title: "Using AI in the builder"
|
||||
description: "Learn how to run resume analysis and use the AI Resume Assistant to review proposed resume changes before applying them."
|
||||
---
|
||||
|
||||
Reactive Resume includes two AI-assisted builder workflows:
|
||||
|
||||
- **Resume Analysis** gives you a score, strengths, and prioritized suggestions.
|
||||
- **AI Resume Assistant** proposes specific edits that you can accept or reject.
|
||||
|
||||
<Info>
|
||||
These features require a tested and enabled AI provider in **Dashboard -> Settings -> Integrations**. For setup, see
|
||||
[Using Artificial Intelligence](/guides/using-ai).
|
||||
</Info>
|
||||
|
||||
## Run a resume analysis
|
||||
|
||||
Use resume analysis when you want a broad review before making changes.
|
||||
|
||||
<Steps>
|
||||
<Step title="Open your resume in the builder">
|
||||
Go to the dashboard and open the resume you want to review.
|
||||
</Step>
|
||||
|
||||
<Step title="Open the Resume Analysis section">
|
||||
In the right sidebar, select **Resume Analysis**.
|
||||
|
||||
<Frame caption="Resume Analysis section in the builder">
|
||||
<img
|
||||
src="/images/guides/using-ai-in-the-builder/screenshot-1.png"
|
||||
alt="Resume Analysis section showing the AI setup prompt in the builder sidebar"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
|
||||
<Step title="Click Analyze Resume">
|
||||
Reactive Resume sends the current resume data to your configured AI provider.
|
||||
</Step>
|
||||
|
||||
<Step title="Review the results">
|
||||
Review the overall score, scorecard, strengths, and suggestions.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
Use the analysis as guidance, not as a final verdict. The best resume still depends on the job, industry, and audience.
|
||||
|
||||
## Open the AI Resume Assistant
|
||||
|
||||
Click the assistant button in the builder dock to open the assistant.
|
||||
|
||||
On desktop, the assistant opens as a movable, resizable panel. On smaller screens, it opens as a full-height sheet.
|
||||
|
||||
If AI is unavailable, the builder shows a link to **Integrations** so you can configure it.
|
||||
|
||||
## Ask for targeted changes
|
||||
|
||||
The assistant works best when you ask for specific, incremental changes.
|
||||
|
||||
Good prompts:
|
||||
|
||||
- "Rewrite my summary for a senior frontend engineer role."
|
||||
- "Tighten the bullets in my most recent job."
|
||||
- "Add measurable impact to my project descriptions."
|
||||
- "Adapt this resume for the job description below."
|
||||
|
||||
Avoid asking it to rewrite everything at once unless you are prepared to review many changes.
|
||||
|
||||
## Review proposals before applying them
|
||||
|
||||
When the assistant proposes edits, Reactive Resume shows a review card with:
|
||||
|
||||
- a proposal title and summary;
|
||||
- badges for the proposed operations;
|
||||
- before and after previews;
|
||||
- the raw JSON Patch for users who want to inspect the exact operations.
|
||||
|
||||
You can:
|
||||
|
||||
- **Accept** one proposal;
|
||||
- **Reject** one proposal;
|
||||
- move between proposals with **Prev** and **Next**;
|
||||
- **Accept all** or **Reject all** from the split-button menu.
|
||||
|
||||
<Warning>
|
||||
Review AI proposals before accepting them. AI can introduce wording that is inaccurate, too generic, or not aligned
|
||||
with your actual experience.
|
||||
</Warning>
|
||||
|
||||
## When a proposal cannot be applied
|
||||
|
||||
A proposal can fail if the resume changed after the assistant generated it, if the resume is locked, or if the proposed patch no longer matches the current resume data.
|
||||
|
||||
If that happens, ask the assistant to regenerate the change from the latest version of the resume.
|
||||
+65
-57
@@ -1,79 +1,87 @@
|
||||
---
|
||||
title: "Using Artificial Intelligence"
|
||||
description: "Learn how to configure an AI provider and API key for AI-assisted features in Reactive Resume"
|
||||
description: "Learn how to configure an AI provider for AI-assisted features in Reactive Resume."
|
||||
---
|
||||
|
||||
Reactive Resume uses AI providers for features such as resume analysis, AI-assisted resume changes, AI agent drafts, and PDF or Word imports.
|
||||
|
||||
## Open AI provider settings
|
||||
|
||||
<Steps>
|
||||
<Step title="Sign in to the dashboard">
|
||||
Head over to [https://rxresu.me](https://rxresu.me) and sign in with your account credentials.
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Artificial Intelligence settings">
|
||||
Once you're in the dashboard, look for the sidebar navigation on the left. Under the <Badge>Settings</Badge> section,
|
||||
click on <Badge>Artificial Intelligence</Badge>.
|
||||
</Step>
|
||||
|
||||
<Step title="How your data is stored and sent">
|
||||
When you configure your AI provider settings on this page, all information (such as the API key and model) is stored locally in your browser and **not** in our database.
|
||||
|
||||
<Info>
|
||||
<strong>Your credentials and AI configuration are never saved on Reactive Resume servers.</strong> They only live in your device's browser storage.
|
||||
</Info>
|
||||
|
||||
However, whenever you use an AI-assisted feature (such as text generation), these credentials need to be sent to the server **temporarily and only for the duration of your request**. This is required to connect with the AI provider on your behalf. See below for a deeper explanation.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Choose a provider">
|
||||
In the <Badge>Provider</Badge> field, choose one of the supported providers:
|
||||
|
||||
- **OpenAI**
|
||||
- **Google Gemini**
|
||||
- **Anthropic Claude**
|
||||
- **Ollama** (coming soon)
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Enter a model name">
|
||||
In the <Badge>Model</Badge> field, enter the model you want to use (for example, <code>gpt-5.2</code>,{" "}
|
||||
<code>claude-4.5-opus</code>, or <code>gemini-3-flash</code>).
|
||||
</Step>
|
||||
|
||||
<Step title="Paste your API key">
|
||||
In the <Badge>API Key</Badge> field, paste your provider API key.
|
||||
|
||||
<Warning>
|
||||
Treat this key like a password. Anyone with it can use your provider account and may incur costs.
|
||||
</Warning>
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Verify it's enabled">
|
||||
After setting the provider, model, and API key, the status indicator at the bottom of the page should show <Badge>Enabled</Badge>.
|
||||
|
||||
<Tip>
|
||||
If the status shows <Badge>Disabled</Badge>, double-check that all three fields are filled in.
|
||||
</Tip>
|
||||
<Step title="Navigate to Integrations settings">
|
||||
In the dashboard sidebar, under **Settings**, click **Integrations**.
|
||||
|
||||
<Frame caption="AI provider settings in Integrations">
|
||||
<img
|
||||
src="/images/guides/using-ai/screenshot-1.png"
|
||||
alt="Integrations settings showing AI provider configuration"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Why AI requests are sent through our server
|
||||
## Add a provider
|
||||
|
||||
Most AI providers (like OpenAI, Gemini, or Anthropic) block requests that come directly from the browser due to something called **CORS** ("Cross-Origin Resource Sharing"), a security mechanism built into web browsers.
|
||||
In the **AI Providers** section, fill out the **Add Provider** form.
|
||||
|
||||
**What is CORS?**
|
||||
CORS is a browser feature that prevents web pages from making requests to a different domain than the one that served the web page, unless that domain explicitly allows it. Most AI providers do not allow browser-based requests from random websites, primarily for security and abuse prevention.
|
||||
| Field | Description |
|
||||
| --- | --- |
|
||||
| **Label** | A name that helps you recognize the provider, such as `Work OpenAI` or `Personal OpenRouter`. |
|
||||
| **Provider** | The provider type, such as OpenAI, Anthropic Claude, Google Gemini, Vercel AI Gateway, OpenRouter, Ollama, or OpenAI-compatible. |
|
||||
| **Model** | The exact model name expected by that provider. |
|
||||
| **Base URL** | The provider endpoint. Leave the default unless you use a gateway, proxy, local provider, or OpenAI-compatible endpoint. |
|
||||
| **API Key** | The key Reactive Resume should use when sending AI requests to that provider. |
|
||||
|
||||
Because of this restriction, the app has to **forward your AI requests (along with your credentials) through our server**, which then contacts the AI provider and returns the response to your browser. **Your credentials are not stored on our server; they are only used to make the request you initiated, and are not logged or retained.**
|
||||
Click **Save Provider** when the form is complete.
|
||||
|
||||
<Warning>
|
||||
Treat API keys like passwords. Anyone with a key can use the connected provider account and may incur costs.
|
||||
</Warning>
|
||||
|
||||
## Test and enable a provider
|
||||
|
||||
After saving a provider, test it before using it.
|
||||
|
||||
<Steps>
|
||||
<Step title="Click Test">
|
||||
Reactive Resume sends a small request to verify the provider, model, base URL, and key.
|
||||
</Step>
|
||||
|
||||
<Step title="Review the status">
|
||||
A successful provider is marked **Tested**. A failed provider is marked **Failed** and may show an error message.
|
||||
</Step>
|
||||
|
||||
<Step title="Enable the provider">
|
||||
Turn on **Use** for the tested provider you want Reactive Resume to use.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<Info>
|
||||
If you're curious or would like to audit how your AI requests are forwarded, you can review the code yourself. See the
|
||||
relevant implementation in <code>src/integrations/orpc/router/ai.ts</code> within the codebase.
|
||||
Only tested providers can be used for AI-assisted features.
|
||||
</Info>
|
||||
|
||||
---
|
||||
## How credentials are stored
|
||||
|
||||
### Do you know a workaround?
|
||||
AI provider credentials are encrypted on the server and are never shown again after saving. The settings page only shows a preview of the saved key.
|
||||
|
||||
If you have a solution or workaround for this CORS-related limitation, please consider raising an [issue or pull request on GitHub](https://github.com/reactive-resume/reactive-resume).
|
||||
If provider management is unavailable, your self-hosted deployment may be missing required server configuration.
|
||||
|
||||
<Warning>
|
||||
AI provider management requires the server-side services used to encrypt credentials and run AI work. If the page says
|
||||
provider management is unavailable, check your deployment configuration before using AI features.
|
||||
</Warning>
|
||||
|
||||
## Where AI is used
|
||||
|
||||
After a provider is tested and enabled, you can use AI in:
|
||||
|
||||
- **Resume Analysis** in the builder's right sidebar;
|
||||
- **AI-assisted resume changes** from the builder;
|
||||
- **Agent** workflows that create isolated AI drafts;
|
||||
- **PDF and Microsoft Word imports** from the dashboard import dialog.
|
||||
|
||||
For the builder workflow, see [Using AI in the builder](/guides/using-ai-in-the-builder). For AI-assisted imports, see [Importing resumes](/guides/importing-resumes).
|
||||
|
||||
@@ -10,7 +10,7 @@ The **Private Notes** section is a dedicated space for storing personal informat
|
||||
Think of it as a built-in notebook attached to each resume where you can jot down anything relevant to your job search.
|
||||
|
||||
<Info>
|
||||
Private Notes are stored securely with your resume data and are only visible to you when editing your resume.
|
||||
Private Notes are stored with that resume's data and are only visible to you when editing the resume.
|
||||
</Info>
|
||||
|
||||
## Where to find it
|
||||
@@ -83,15 +83,15 @@ Track your follow-up schedule:
|
||||
</Step>
|
||||
|
||||
<Step title="Notes save automatically">
|
||||
Your notes are saved automatically as you type—there's no need to click a save button.
|
||||
Your notes are saved automatically as you type. There's no need to click a save button.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Privacy guarantee
|
||||
|
||||
<Warning>
|
||||
Private Notes are for your eyes only. They will **never** appear on: - Your exported PDF or other file formats - Your
|
||||
publicly shared resume link - Any printed version of your resume
|
||||
Private Notes are for your eyes only. They will **never** appear in your exported files, on your public resume link, or
|
||||
in a printed version of your resume.
|
||||
</Warning>
|
||||
|
||||
This makes it safe to store sensitive information like salary expectations, candid thoughts about opportunities, or personal reminders that you wouldn't want an employer to see.
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "Using the builder dock"
|
||||
description: "Learn how to use the floating dock in the resume builder for zooming, page layout, sharing, exports, and AI assistance."
|
||||
---
|
||||
|
||||
The builder dock is the floating toolbar at the bottom of the resume builder. It gives you quick access to preview controls, sharing, exports, and the AI assistant without leaving the resume canvas.
|
||||
|
||||
<Frame caption="Resume builder with the floating dock">
|
||||
<img
|
||||
src="/images/guides/using-the-builder-dock/screenshot-1.png"
|
||||
alt="Resume builder showing the floating dock with preview controls and download shortcuts"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
## Preview controls
|
||||
|
||||
Use the left side of the dock to control the preview.
|
||||
|
||||
| Control | What it does |
|
||||
| --- | --- |
|
||||
| **Zoom in** | Increases the preview zoom. |
|
||||
| **Zoom out** | Decreases the preview zoom. |
|
||||
| **Center view** | Re-centers the resume preview in the canvas. |
|
||||
| **Toggle page stacking** | Switches between stacked pages and side-by-side pages. |
|
||||
|
||||
These controls only affect the editor preview. They do not change the exported PDF, DOCX, or JSON file.
|
||||
|
||||
## Open the AI assistant
|
||||
|
||||
Click the assistant button to open or close the **AI Resume Assistant**.
|
||||
|
||||
The assistant can propose targeted resume changes, such as rewriting a summary, tightening bullet points, adding metrics, or tailoring the resume to a job description. You review proposed changes before they are applied.
|
||||
|
||||
<Info>
|
||||
The assistant requires a tested and enabled AI provider. See
|
||||
[Using Artificial Intelligence](/guides/using-ai) for setup and [Using AI in the builder](/guides/using-ai-in-the-builder)
|
||||
for the builder workflow.
|
||||
</Info>
|
||||
|
||||
## Copy the public URL
|
||||
|
||||
Click **Copy URL** to copy the resume's public link.
|
||||
|
||||
The URL is based on your username and the resume slug:
|
||||
|
||||
```txt
|
||||
https://rxresu.me/{username}/{slug}
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Copying the URL does not make the resume public by itself. To allow visitors to open the link, enable public access in
|
||||
the **Sharing** section of the right sidebar.
|
||||
</Warning>
|
||||
|
||||
## Download files from the dock
|
||||
|
||||
The dock includes quick download buttons for:
|
||||
|
||||
- **JSON** for backups, imports, and structured data workflows;
|
||||
- **DOCX** for editing in Microsoft Word or Google Docs;
|
||||
- **PDF** for sharing, uploading, and printing.
|
||||
|
||||
These are the same export formats available in the right sidebar's **Export** section.
|
||||
|
||||
<Tip>
|
||||
Use the dock when you already know which file you need. Use the right sidebar's **Export** section when you want the
|
||||
format descriptions next to each button.
|
||||
</Tip>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 51 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 205 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 209 KiB |
Reference in New Issue
Block a user