mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-10-03 10:13:47 +10:00
docs: point the guides at the new settings pages
Guides now name Account, Preferences and AI & developer, the new key flow, and what the account export contains.
This commit is contained in:
Amruth Pillai
@@ -41,7 +41,7 @@ description: "Sign up for a Reactive Resume account with email and password or s
|
||||
- lets you reset your password if you forget it
|
||||
|
||||
<Info>
|
||||
You can verify your email at any time from your account settings. Look for the verification prompt in your dashboard or navigate to **Settings → Profile**.
|
||||
You can verify your email at any time from your account settings. Look for the verification prompt in your dashboard or navigate to **Settings → Account**.
|
||||
</Info>
|
||||
</Step>
|
||||
|
||||
|
||||
@@ -122,7 +122,7 @@ Reactive Resume provides three different JSON shapes:
|
||||
| --- | --- | --- | --- |
|
||||
| **Single resume** | In the builder, open **Download**, stay on **Resume**, and download **JSON**. | Resume content and settings, including cover letter sections embedded in that resume. | Yes. |
|
||||
| **Independent cover letter** | Open a letter from **Cover Letters** on the dashboard and select **Export JSON**. | That letter's content and copied resume styling in the Reactive Resume cover-letter format. | No. Import it through the cover-letter library instead. |
|
||||
| **Account archive** | Open **Settings**, go to **Account**, and select **Export my data**. | Account profile metadata, all owned resume records, independent cover letters, and an `exportedAt` timestamp. | No. It is an archive, not a single-resume import file. |
|
||||
| **Account archive** | Open **Settings**, go to **Account**, and under **Your data** select **Export**. | A zip with `account.json` (profile and an `exportedAt` timestamp), each resume and cover letter as its own JSON file, and `applications.json`. | No. It is an archive, not a single-resume import file. |
|
||||
|
||||
Use the single-resume and independent-cover-letter exports for the Git workflow below. An account archive is an additional portability backup, not a replacement for those files. Because its `exportedAt` timestamp changes on every export, do not expect otherwise unchanged account archives to be byte-for-byte identical.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Reactive Resume can create a new resume from several existing file formats. Use
|
||||
|
||||
<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.
|
||||
**Settings → AI & developer** before using those import types.
|
||||
</Info>
|
||||
|
||||
## Import a resume
|
||||
@@ -49,7 +49,7 @@ Reactive Resume can create a new resume from several existing file formats. Use
|
||||
Click **Import**. Reactive Resume creates a new resume and opens it in the builder when the import succeeds.
|
||||
|
||||
For PDF and Microsoft Word files, the dialog checks that you have a working AI provider configured before it starts.
|
||||
If none is available, you'll get a link to **Integrations** to set one up.
|
||||
If none is available, you'll get a link to **AI & developer** settings to set one up.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
@@ -71,7 +71,7 @@ If you only have a PDF or Word document, choose **PDF** or **Microsoft Word**. A
|
||||
|
||||
### 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.
|
||||
Open **Settings → AI & developer**, fill in your AI provider settings, test the connection, and enable AI features.
|
||||
|
||||
### The imported resume is incomplete
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ description: "Connect or disconnect social sign-in providers like Google and Git
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Authentication settings">
|
||||
In the dashboard sidebar on the left, under <Badge>Settings</Badge>, click the <Badge>Authentication</Badge> link.
|
||||
Open <Badge>Settings</Badge> from your avatar and choose <Badge>Account</Badge>. Everything about signing in is under **Sign-in & security**.
|
||||
</Step>
|
||||
|
||||
<Step title="Find the social provider you want to link">
|
||||
|
||||
@@ -9,7 +9,7 @@ description: "Register WebAuthn passkeys on your Reactive Resume account to sign
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Authentication settings">
|
||||
In the dashboard sidebar on the left, under <Badge>Settings</Badge>, click the <Badge>Authentication</Badge> link.
|
||||
Open <Badge>Settings</Badge> from your avatar and choose <Badge>Account</Badge>. Everything about signing in is under **Sign-in & security**.
|
||||
</Step>
|
||||
|
||||
<Step title="Register a new device">
|
||||
|
||||
@@ -23,7 +23,7 @@ description: "Enable TOTP two-factor authentication on your Reactive Resume acco
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Authentication settings">
|
||||
In the dashboard sidebar on the left, under <Badge>Settings</Badge>, click the <Badge>Authentication</Badge> link.
|
||||
Open <Badge>Settings</Badge> from your avatar and choose <Badge>Account</Badge>. Everything about signing in is under **Sign-in & security**.
|
||||
</Step>
|
||||
|
||||
<Step title="Click on Enable 2FA">
|
||||
|
||||
@@ -14,7 +14,7 @@ description: "Update your Reactive Resume profile information, including your di
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Profile settings">
|
||||
In the dashboard sidebar on the left, under <Badge>Settings</Badge>, click the <Badge>Profile</Badge> link.
|
||||
Open <Badge>Settings</Badge> from your avatar and choose <Badge>Account</Badge>. Your name, username, email and photo are under **Profile**, and each change saves when you leave the field.
|
||||
</Step>
|
||||
|
||||
<Step title="Update your information">
|
||||
|
||||
@@ -11,7 +11,7 @@ The AI Agent workspace is where you work with an AI assistant on a resume draft.
|
||||
|
||||
## Before you start
|
||||
|
||||
You need at least one AI provider that is tested and enabled in **Dashboard → Settings → Integrations**. For setup, see [Using artificial intelligence](/guides/using-ai).
|
||||
You need at least one AI provider that is tested and enabled in **Settings → AI & developer**. For setup, see [Using artificial intelligence](/guides/using-ai).
|
||||
|
||||
If you self-host Reactive Resume, the agent workspace also requires the server-side agent configuration described in [Self-hosting with Docker](/self-hosting/docker).
|
||||
|
||||
@@ -90,7 +90,7 @@ Use this controlled workflow to test tailoring without relying on live web resea
|
||||
|
||||
<Steps>
|
||||
<Step title="Set up an AI provider">
|
||||
In **Dashboard → Settings → Integrations**, configure a supported AI provider, test it, and make sure it is enabled. Then return to **Agents**.
|
||||
In **Settings → AI & developer**, configure a supported AI provider, test it, and make sure it is enabled. Then return to **Agents**.
|
||||
</Step>
|
||||
|
||||
<Step title="Open a sample resume draft">
|
||||
|
||||
@@ -9,7 +9,7 @@ Reactive Resume includes two AI-assisted builder workflows:
|
||||
- The **ATS Check** section can add an optional AI review of your writing on top of its deterministic report.
|
||||
|
||||
<Info>
|
||||
These features require a tested and enabled AI provider in **Dashboard → Settings → Integrations**. For setup, see
|
||||
These features require a tested and enabled AI provider in **Settings → AI & developer**. For setup, see
|
||||
[Using artificial intelligence](/guides/using-ai).
|
||||
</Info>
|
||||
|
||||
@@ -25,7 +25,7 @@ Click the **Sparkle** button in the builder header, next to the resume name, to
|
||||
|
||||
The assistant opens as a side panel next to your resume. It uses the same chat interface as the AI Agent workspace, but stays scoped to the resume you are editing. Its edits land in the builder immediately, appear in the preview, and are captured in undo history and version history.
|
||||
|
||||
If AI is unavailable, the panel shows a link to **Integrations** so you can configure a provider.
|
||||
If AI is unavailable, the panel shows a link to **AI & developer** settings so you can configure a provider.
|
||||
|
||||
<Tip>
|
||||
The Sparkle button is the in-builder assistant. The chat-bubble icon on the floating dock opens the full **AI Agent**
|
||||
|
||||
@@ -12,13 +12,13 @@ Reactive Resume uses AI providers for features such as AI-assisted resume change
|
||||
Head over to [https://rxresu.me](https://rxresu.me) and sign in with your account credentials.
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to Integrations settings">
|
||||
In the dashboard sidebar, under **Settings**, click **Integrations**.
|
||||
<Step title="Open AI & developer settings">
|
||||
Open **Settings** from your avatar and choose **AI & developer**.
|
||||
|
||||
<Frame caption="AI provider settings in Integrations">
|
||||
<Frame caption="AI provider settings in AI & developer">
|
||||
<img
|
||||
src="/images/guides/using-ai/screenshot-1.webp"
|
||||
alt="Integrations settings showing AI provider configuration"
|
||||
alt="AI & developer settings showing AI provider configuration"
|
||||
/>
|
||||
</Frame>
|
||||
</Step>
|
||||
@@ -38,10 +38,10 @@ In the **AI Providers** section, fill out the **Add Provider** form. The form is
|
||||
|
||||
Click **Save Provider** when the form is complete. The connection is tested as part of the save, so the success or failure status appears right away.
|
||||
|
||||
<Frame caption="Saved AI provider in Integrations">
|
||||
<Frame caption="Saved AI provider in AI & developer">
|
||||
<img
|
||||
src="/images/guides/using-ai/screenshot-2.webp"
|
||||
alt="Integrations settings showing a saved and tested AI provider"
|
||||
alt="AI & developer settings showing a saved and tested AI provider"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
|
||||
@@ -8,24 +8,19 @@ description: "Create Reactive Resume API keys, authenticate REST requests with b
|
||||
Head over to [https://rxresu.me](https://rxresu.me) and sign in with your account credentials.
|
||||
</Step>
|
||||
|
||||
<Step title="Navigate to API Keys settings">
|
||||
In the dashboard sidebar on the left, under <Badge>Settings</Badge>, click the <Badge>API Keys</Badge> link.
|
||||
<Step title="Open AI & developer settings">
|
||||
Open <Badge>Settings</Badge> from your avatar and choose <Badge>AI & developer</Badge>. API keys are listed under **API keys**.
|
||||
</Step>
|
||||
|
||||
<Step title="Open the API reference">
|
||||
On the API Keys page, click <Badge>API Documentation</Badge> to open the API reference.
|
||||
|
||||
<Tip>
|
||||
You can also open it directly here: [API Reference](https://docs.rxresu.me/api-reference).
|
||||
</Tip>
|
||||
|
||||
The endpoints, request format and authentication are described in the [API Reference](https://docs.rxresu.me/api-reference).
|
||||
</Step>
|
||||
|
||||
<Step title="Create a new API key">
|
||||
Click <Badge>Create a new API key</Badge>. Fill in:
|
||||
Click <Badge>New key</Badge>. Fill in:
|
||||
|
||||
- **Name**: A label to help you identify what you use this key for
|
||||
- **Expires in**: How long the key should remain valid
|
||||
- **What's it for?**: A name to help you identify what you use this key for
|
||||
- **Expires**: 30 days, 90 days or Never
|
||||
|
||||
</Step>
|
||||
|
||||
@@ -53,10 +48,10 @@ description: "Create Reactive Resume API keys, authenticate REST requests with b
|
||||
</Step>
|
||||
|
||||
<Step title="Delete an API key (optional)">
|
||||
In the API Keys list, click the trash icon next to a key and confirm deletion.
|
||||
In the API keys table, click <Badge>Revoke</Badge> next to a key.
|
||||
|
||||
<Warning>
|
||||
Deleted API keys stop working immediately, and the action cannot be undone.
|
||||
A revoked key stops working immediately. Undo in the message that appears brings it back; once the message goes, the key is deleted for good.
|
||||
</Warning>
|
||||
|
||||
</Step>
|
||||
|
||||
@@ -68,7 +68,7 @@ The **ATS Check** section in the builder's right sidebar has two tiers:
|
||||
Once a report exists, you can ask an AI provider to review the **writing**: weak phrasing, bullets that describe duties rather than outcomes, and where a rewrite would land better.
|
||||
|
||||
<Info>
|
||||
The AI review needs your own tested AI provider in **Dashboard → Settings → Integrations**. See [Using Artificial
|
||||
The AI review needs your own tested AI provider in **Settings → AI & developer**. See [Using Artificial
|
||||
Intelligence](/guides/using-ai).
|
||||
</Info>
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) is a standar
|
||||
</Step>
|
||||
|
||||
<Step title="If using API key, create one">
|
||||
Head over to [https://rxresu.me](https://rxresu.me) (or your self-hosted instance), sign in, and navigate to **Settings → API Keys**. Click **Create a new API key**, give it a name, and copy the secret. It is shown only once.
|
||||
Head over to [https://rxresu.me](https://rxresu.me) (or your self-hosted instance), sign in, and navigate to **Settings → AI & developer**. Under **API keys**, click **New key**, give it a name, and copy the secret. It is shown only once.
|
||||
|
||||
For the full walkthrough, see [Using the API](/guides/using-the-api).
|
||||
|
||||
@@ -372,7 +372,7 @@ For a complete workflow and prompt library, see [Managing applications with MCP]
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| "Unauthorized" with no login prompt | Your client may not support MCP OAuth discovery. Use API key mode (`x-api-key`) |
|
||||
| OAuth login opens but fails redirect/callback | Confirm your client's MCP OAuth callback settings and retry the connection |
|
||||
| "API error (401)" | Your API key is invalid or expired. Create a new one in **Settings → API Keys** |
|
||||
| "API error (401)" | Your API key is invalid or expired. Create a new one in **Settings → AI & developer** |
|
||||
| "API error (404)" | The resume ID doesn't exist. Use `list_resumes` to find valid IDs |
|
||||
| "API error (403)" | The resume is locked. Unlock it in the Reactive Resume dashboard |
|
||||
| Connection refused | Check that the URL is correct and the instance is running |
|
||||
|
||||
Reference in New Issue
Block a user