Documentation of Local Files

Discussion
1

Hi

The Add Doc function seems to crawl and index documents by specifying URLs, but is it possible to convert local files and folders to Doc?

2 Likes
2

I recommend making your local documentation a part of your codebase and then recomputing your codebase index. This way, the codebase context features can also read your documentation.

1 Like
3

Thanks for the great explanation. Could you be a little more specific?

Not sure if this is relevant, but do you know what does the bar chart in the video show?
*I have seen this % exceed 100, but I don’t understand what you are targeting as 100%.

4

It looks like you’re using an old version of Cursor. Please re-download it from https://cursor.sh/.

My apologies, I’ll try to be more specific:

  1. Create a new folder inside your project folder where you’ll place all your local documentation.
  2. Open your project folder in Cursor.
  3. Open the Cursor AI Pane (Ctrl + L).
  4. Navigate to the “More” tab.
  5. Under “Codebase Indexing” click on “Compute Index” or “Resync Index” if you already have an index.
  6. Now you can write “@Codebase” in the chat or use the “Ctrl + Enter” chatbind to retrieve the most relevant parts of your codebase for your question. Since your local documentation is now part of your codebase, it will also consider your local documentation.
1 Like
5

Thanks for the great answer, I guess the version was out of date.

・BTW. Doesn’t it auto-update? Where can I check the version?

・Also, I was able to load all folders as you described with the index function.
It would also be possible to index information on the internet by setting the URL. On the other hand, I would like to import local files such as notes and other notations found at meetings, etc. Is there a way to do this?

6

  1. Yes, it should auto-update. You can check the version by going to the menu bar at the top left, clicking “Help” => “About” and then a window will open with all the information.

  2. Yes, you can place any text-based files you want to use into your project folder to include them in your codebase context, as I described in my previous answer.

7

got it perfect answer .thank you.

1 Like
8

The local docs should be stored independently from the project, like the crawled docs as it can be a hassle to always have to import them for every new project.

2 Likes
9

I agree with this – storing local docs outside of the project.

However, how does one include non project files in the cursor index? I only see that one can add remote urls, not local files in other folders. Have you been able to achieve this? Please share if so.

Thanks in advance

10

The only way I can think that this is possible at the moment is by using workspaces where you can add files from multiple folders on your machine into one “workspace”, which Cursor would index as if it was all one big codebase.

See more info here (works the same in Cursor as VSCode):