How to add custom documentation in Cursor AI

Introduction

Want to add your custom documentation to Cursor AI and make development faster? This guide walks you through each step to make that happen. By the end, you’ll have everything set up and working for you.

Why Custom Documentation Helps

How Does It Make Things Easier?

Custom documentation makes things easier because you can quickly find the information you need without leaving Cursor AI. It helps reduce mistakes by providing references when you need them, and it also improves teamwork since everyone has access to the same details.

Personalizing Cursor AI to Your Workflow

When you customize Cursor AI, it fits your needs better. This makes development simpler, quicker, and less frustrating because you won’t have to switch between different apps all the time.

What Cursor AI Has by Default

What’s Built In?

Cursor AI already includes documentation for popular frameworks like React, Angular, Node.js, and some key Python libraries.

Is Your Framework Included?

To find out if your framework is supported, use the @<framework> command in Cursor AI’s chat or composer. If it appears, then the documentation is already available, and you don’t have to add it.

Checking Existing Documentation

How to Search What’s There

Cursor AI has a large library of built-in documentation. To see what’s included, go to Cursor Docs and use the search tool to find your framework. You can also look through the different categories for more information.

Using @<framework> to Your Advantage

Type the @ symbol followed by your framework’s name. If Cursor AI suggests it, click on it to see the documentation right away.

Getting Ready to Add Your Documentation

What to Have on Hand

Before adding your custom documentation, make sure it’s well-organized. It should be in a format like Markdown or JSON, and you should have access to the documentation source, like a link from GitHub.

Common Compatibility Checks

Be aware that large documentation files may need to be divided into smaller parts. If your documentation uses a format Cursor AI doesn’t support, you may need to convert it.

Cursor AI Settings for Documentation

Where to Find the Right Options

To access the settings, open Cursor AI and click on the gear icon that stands for Settings. Then, go to Features and choose Docs. It’s easy to find, and you’ll be able to manage your documentation from there.

Quick Guide to Access Settings

When you open Cursor AI, click on Settings. Then, go into Features and click on Docs to set things up.

Uploading Your Custom Docs

Steps to Add Your Files

To add your custom documentation, go to the Docs section and click "Add Documentation." You can then upload your file or enter a URL. Just follow the steps on the screen to finish.

What Formats Work?

Cursor AI supports formats like Markdown, JSON, and plain text. These are the best options for your documentation.

Formatting for Easy Indexing

Why It Matters

Formatting is important because it helps Cursor AI understand and find your documentation faster. It also makes sure the search results are accurate and relevant.

Simple Tips for Good Formatting

Make sure to use clear headings and include metadata if you can. Avoid making the formatting too complicated.

Checking If It’s Indexed

Spotting the "Book" Icon

After uploading your documentation, look for the "book" icon. If it’s visible, it means your documentation is indexed correctly, and you can click on it to check.

If It Doesn’t Work

If the icon doesn’t appear, try refreshing Cursor AI, uploading the documentation again, or checking if there are format issues.

Fixing Common Problems

Troubleshooting Guide

If your documentation isn’t showing up, consider splitting large files into smaller ones. If there are formatting problems, convert your files to Markdown or JSON.

Using GitHub for Easy Uploads

You can also use GitHub. Copy the GitHub URL and replace ‘github.com’ with ‘raw.githubusercontent.com’. Use this new link to upload the file.

Advanced Integration Tips

What Formats Work Best?

Markdown and JSON are the best formats to use. Markdown is ideal for text, and JSON is great for structured data.

Quick GitHub URL Trick

If you need to upload a file from GitHub, change the URL from https://github.com/user/repo to https://raw.githubusercontent.com/user/repo/main/README.md. Cursor AI will then be able to access the raw file directly.

Manual Input for Smaller Docs

When It’s Useful

Manual input is helpful for smaller sections of documentation or if you’re just testing things. You can paste the text directly into Cursor AI and format it as needed.

Other Options to Consider

If Cursor AI Isn’t Enough

If Cursor AI doesn’t cover all your needs, you can try other tools like OpenAI’s GPT-4 or AI tools made for specific types of documentation.

Getting Started with v0.dev

For setting up frameworks, you can use v0.dev. It helps you build your initial setup, which you can then import into Cursor AI.

Starting Projects Smoothly

Using v0.dev for Initial Apps

Choose the framework you want to use and set up your project on v0.dev. After setting up, you can import the project into Cursor AI to continue working efficiently.

Making the Switch Easy

When you bring your project to Cursor AI, it’s ready for you to use with your custom documentation. This makes development smoother and faster.

The Long-Term Benefits

With your custom documentation in place, you’ll always have the information you need at your fingertips. This will help you work faster, avoid mistakes, and keep your projects consistent.

Got Questions?

1. If you want to know if your docs are indexed, look for the "book" icon.
2. If you have non-standard formats, convert them to Markdown or JSON before uploading.
3. For indexing issues, try re-uploading, breaking large files into smaller ones, or checking the format.
4. Keep your documentation current by updating and re-indexing when necessary.
5. While automated updates aren’t available yet, scripting the steps can make the process easier.

Got everything you need? Go ahead and set up your custom documentation to get the most out of Cursor AI. Happy developing!