mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-07-11 05:24:59 +10:00
docs: tighten SEO titles and descriptions across new docs (#3232)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Sponsors
|
||||
description: Meet the sponsors supporting Reactive Resume.
|
||||
description: "Meet the individuals, companies, and open-source backers whose GitHub sponsorships fund ongoing development and hosting of Reactive Resume."
|
||||
---
|
||||
|
||||
Reactive Resume stays free, open-source, and independent because companies choose to support the work behind it. Thank you to every sponsor who helps fund hosting, maintenance, and continued development for the community.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Spotlight"
|
||||
description: "A showcase of articles, videos, and social media posts from the Reactive Resume community"
|
||||
description: "Discover articles, YouTube videos, tutorials, and social media posts about Reactive Resume shared by users, reviewers, and community members."
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Project Architecture"
|
||||
description: "Understand the Reactive Resume monorepo, runtime boundaries, and package ownership model"
|
||||
description: "Explore the Reactive Resume monorepo layout, runtime boundaries between client, server, artboard, and worker apps, and the package ownership model."
|
||||
---
|
||||
|
||||
Reactive Resume is a pnpm/Turborepo monorepo. The product runs as one deployed Node.js process, while the source is split into a full-stack web app, a server adapter, and focused internal packages.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Development Setup"
|
||||
description: "Set up a local development environment for Reactive Resume"
|
||||
description: "Set up a local development environment for Reactive Resume with pnpm, Docker services, environment variables, and the client, server, and worker apps."
|
||||
---
|
||||
|
||||
<Info>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Contributing Translations"
|
||||
description: "Help translate Reactive Resume into your language using Crowdin"
|
||||
description: "Contribute translations for Reactive Resume through Crowdin by joining the project, proposing strings, requesting new languages, and syncing updates."
|
||||
---
|
||||
|
||||
Reactive Resume is used by people all around the world, and translations help make the app accessible to everyone. If you speak a language other than English, you can help by contributing translations.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Introduction"
|
||||
description: "Welcome to the documentation for Reactive Resume, a free and open-source resume builder that simplifies the process of creating, updating, and sharing your resume."
|
||||
title: "Introduction to Reactive Resume"
|
||||
description: "Reactive Resume is a free, open-source resume builder that lets you create, update, export, and share professional resumes without accounts or paywalls."
|
||||
---
|
||||
|
||||
<Frame>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Quickstart"
|
||||
description: "Get started with Reactive Resume in minutes — use our hosted version or deploy your own instance"
|
||||
description: "Get started with Reactive Resume in minutes by signing in to the hosted version or deploying your own self-hosted instance with Docker Compose."
|
||||
---
|
||||
|
||||
## Options
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "AI Agent Tools"
|
||||
description: "Understand the tools available to the AI Agent workspace and how they affect resume drafts."
|
||||
description: "Reference for the tools the Reactive Resume AI Agent can call to read, edit, patch, and preview resume drafts inside an isolated workspace."
|
||||
---
|
||||
|
||||
The AI Agent workspace can use a curated set of tools while it chats with you. You do not call these tools directly; the agent chooses them when your request needs resume data, supported provider web context, attachments, questions, or a resume patch.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Checking Service Status"
|
||||
description: "Learn how to check the status of Reactive Resume's servers and what to do if the service is experiencing issues"
|
||||
description: "Check the current uptime and incident status for Reactive Resume's hosted servers and learn what to do when the service is experiencing issues."
|
||||
---
|
||||
|
||||
## Status Page
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Choosing a template"
|
||||
description: "Learn how to choose the perfect template for your resume and explore all available template designs in Reactive Resume."
|
||||
description: "Compare the built-in Reactive Resume templates, preview each layout, and switch between them from the builder to pick the best design for your resume."
|
||||
---
|
||||
|
||||
Reactive Resume offers a variety of unique templates, each with its own design aesthetic. This guide will help you understand the differences between templates and how to change your resume's template at any time.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Creating an account"
|
||||
description: "Learn how to create an account on Reactive Resume and get started on building your resume"
|
||||
description: "Sign up for a Reactive Resume account with email and password or social sign-in from Google or GitHub so you can start building and saving resumes."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Creating your first resume"
|
||||
description: "Learn how to create your first resume in Reactive Resume, set a name and slug, and open it in the builder."
|
||||
description: "Create your first resume in Reactive Resume by naming it, choosing a URL slug, and opening it in the builder to start filling in your details."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Fitting content on a page"
|
||||
description: "Learn how to reorganize and format your resume content to fit within a single page, whether you're using A4 or Letter format."
|
||||
description: "Reorganize sections, tune typography, adjust margins, and trim content to fit your Reactive Resume on a single A4 or Letter page without overflow."
|
||||
---
|
||||
|
||||
When your resume content overflows the page, Reactive Resume displays a warning just below the page. This guide explains how to reorganize and adjust your content so everything fits within your chosen page format.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Linking social accounts"
|
||||
description: "Learn how to connect or disconnect social sign-in providers like Google and GitHub from your account"
|
||||
description: "Connect or disconnect social sign-in providers like Google and GitHub to your Reactive Resume account so you can log in without a password."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Moving items between sections"
|
||||
description: "Learn how to move resume items from one section to another, or to a different page, to better organize your content and split lengthy sections across multiple pages."
|
||||
description: "Move resume items between sections or across pages in the Reactive Resume builder to reorganize content and split lengthy sections cleanly."
|
||||
---
|
||||
|
||||
If you have a long work history or extensive project list, you may want to split items across multiple pages or reorganize them into different sections. The **Move to** feature lets you do exactly that—quickly relocate any item to another section or page with just a few clicks.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Selecting the right page format"
|
||||
description: "Learn about the three page format options in Reactive Resume—A4, Letter, and Free-Form—and choose the best one for your needs."
|
||||
description: "Compare the A4, Letter, and Free-Form page format options in Reactive Resume and pick the right size, margins, and orientation for your resume."
|
||||
---
|
||||
|
||||
Reactive Resume offers three page format options: **A4**, **Letter**, and **Free-Form**. Each format affects how your resume is rendered and exported as a PDF. This guide explains the differences and helps you choose the right format for your situation.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Setting up passkeys"
|
||||
description: "Learn how to register passkeys (WebAuthn) to sign in securely using biometrics or your device PIN"
|
||||
description: "Register WebAuthn passkeys on your Reactive Resume account to sign in with biometrics, a device PIN, or a security key instead of a password."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Setting up two-factor authentication"
|
||||
description: "Learn how to enable two-factor authentication (2FA) to add an extra layer of security to your Reactive Resume account"
|
||||
description: "Enable TOTP two-factor authentication on your Reactive Resume account with an authenticator app, save recovery codes, and manage 2FA settings."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Updating your profile"
|
||||
description: "Learn how to update your profile information including your name, username, and email address in Reactive Resume"
|
||||
description: "Update your Reactive Resume profile information, including your display name, username, email address, and profile picture from account settings."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Using the AI Agent Workspace"
|
||||
description: "Learn how to start an isolated AI draft, chat with an agent, review resume patches, and continue existing agent threads."
|
||||
description: "Start an isolated AI draft in the Reactive Resume Agent workspace, chat with the agent, review proposed resume patches, and resume prior threads."
|
||||
---
|
||||
|
||||
The AI Agent workspace is a dedicated place to work with an AI assistant on a resume draft. It keeps the conversation, tool activity, and read-only resume preview in one full-screen view.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Using the API"
|
||||
description: "Learn how to create API keys and authenticate requests to the Reactive Resume API"
|
||||
description: "Create Reactive Resume API keys, authenticate REST requests with bearer tokens, and integrate resume data into your own scripts, apps, or automations."
|
||||
---
|
||||
|
||||
<Steps>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Using the MCP Server"
|
||||
description: "Connect Reactive Resume to AI tools like Claude Desktop, Cursor, and Codex using the Model Context Protocol"
|
||||
description: "Connect Reactive Resume to AI tools like Claude Desktop, Cursor, and Codex through the Model Context Protocol to edit and manage resumes via chat."
|
||||
---
|
||||
|
||||
The Reactive Resume MCP server lets you manage and modify your resumes and job applications through any MCP-compatible AI tool - Claude Desktop, Cursor, Codex, and more. It connects to the Reactive Resume API and exposes tools for resume editing, Application Tracker workflows, and AI-assisted job application tasks using natural language.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Using the Patch API"
|
||||
description: "Learn how to partially update your resume using JSON Patch (RFC 6902) operations"
|
||||
description: "Partially update a Reactive Resume with JSON Patch (RFC 6902) operations to add, remove, replace, and move fields without sending the full document."
|
||||
---
|
||||
|
||||
The Patch API lets you make small, targeted changes to your resume without sending the entire data object. Instead of replacing the whole resume with a `PUT`, you send a list of **JSON Patch** operations that describe exactly what to change.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "License"
|
||||
description: "Reactive Resume is open-source software licensed under MIT."
|
||||
description: "Read the MIT license that covers Reactive Resume, an open-source resume builder you can freely use, modify, self-host, and redistribute."
|
||||
---
|
||||
|
||||
## Open Source License (MIT)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Privacy Policy"
|
||||
description: "How Reactive Resume handles personal data, cookies, uploads, and printing."
|
||||
description: "How the hosted Reactive Resume service handles your personal data, account information, uploaded files, cookies, analytics, and PDF printing."
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Terms of Service"
|
||||
description: "Terms and conditions for using Reactive Resume, including accounts, public resumes, uploads, and exports."
|
||||
description: "Terms and conditions for using the hosted Reactive Resume service, covering accounts, acceptable use, public resumes, uploads, exports, and liability."
|
||||
---
|
||||
|
||||
## Agreement
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Docker Compose Examples"
|
||||
description: "A collection of Docker Compose examples for different deployment scenarios. If you have a different setup that works for you, please share it by opening a pull request on GitHub."
|
||||
description: "Ready-to-use Docker Compose examples for self-hosting Reactive Resume with Postgres, Traefik, Caddy, Nginx Proxy Manager, and other common deployment stacks."
|
||||
---
|
||||
|
||||
<Info>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Migrating from v4 to v5"
|
||||
description: "A step-by-step guide to migrate your Reactive Resume instance from v4 to v5, including manual and automated migration options."
|
||||
description: "Step-by-step guide to migrate a self-hosted Reactive Resume instance from v4 to v5, covering database schema changes, manual and automated options."
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Single Sign-On (SSO)"
|
||||
description: "A guide to setting up custom OAuth providers like Authentik, Authelia, Keycloak, or any OIDC-compliant identity provider for Single Sign-On (SSO) in your self-hosted instance."
|
||||
description: "Configure Single Sign-On for self-hosted Reactive Resume using custom OAuth providers like Authentik, Authelia, Keycloak, or any OIDC-compliant IdP."
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "AI Resume Builder"
|
||||
description: "Use Reactive Resume with optional BYO-provider AI assistance for resume analysis, builder edits, imports, and agent drafts."
|
||||
description: "Use Reactive Resume as an AI resume builder with bring-your-own OpenAI, Anthropic, Gemini, OpenRouter, or Ollama providers for edits and drafts."
|
||||
---
|
||||
|
||||
Reactive Resume can be used as an AI-assisted resume builder, but AI is optional and bring-your-own-provider: you configure the provider, model, endpoint, and API key you want Reactive Resume to use.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Export and Share Resumes"
|
||||
description: "Export Reactive Resume resumes as PDFs and share public resume URLs with human recipients."
|
||||
description: "Export Reactive Resume resumes as PDF, DOCX, Markdown, or JSON files and share password-protected public URLs with recruiters and hiring managers."
|
||||
---
|
||||
|
||||
Reactive Resume lets you export resumes as PDFs and, when useful, share a public resume URL with human recipients such as recruiters, hiring managers, collaborators, or your own portfolio visitors. Public resume URLs are not search-indexed by default.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Free Resume Builder"
|
||||
description: "Use Reactive Resume as a free resume builder for creating, editing, exporting, and sharing resumes."
|
||||
description: "Reactive Resume is a free resume builder with no paywalls or premium tiers for creating, editing, exporting, and sharing unlimited resumes online."
|
||||
---
|
||||
|
||||
Reactive Resume is a free resume builder for creating resumes in a browser, choosing a template, exporting a PDF, and sharing a human-readable public URL when you want someone else to view it. Public resume URLs are shareable for human recipients and are not search-indexed by default.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Privacy-Focused Resume Builder"
|
||||
description: "Understand the privacy-focused parts of Reactive Resume, including open source transparency, self-hosting, public sharing controls, and optional AI provider configuration."
|
||||
description: "Reactive Resume's privacy-focused design: open source transparency, self-hosting, public sharing controls, and optional bring-your-own AI providers."
|
||||
---
|
||||
|
||||
Reactive Resume is a privacy-focused resume builder because it is open source, can be self-hosted, supports private-by-default resume editing, and makes sharing and optional AI features explicit choices.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Self-Hosted Resume Builder"
|
||||
description: "Run Reactive Resume as a self-hosted resume builder with Docker, PostgreSQL, optional storage, SSO, and migration guidance."
|
||||
description: "Run Reactive Resume as a self-hosted resume builder with Docker Compose, PostgreSQL, optional object storage, Single Sign-On, and v4 to v5 migration."
|
||||
---
|
||||
|
||||
Reactive Resume can be run as a self-hosted resume builder when you want to operate the app on your own infrastructure instead of using the hosted instance.
|
||||
|
||||
Reference in New Issue
Block a user