Hello all,
What is the recommended way to load docs into Cursor? Currently, I am building an app that uses the NuxtUI components library and it’s not part of the default Docs library from Cursor. Thus, I tried to add the path to the docs crawler in Cursor settings, but it only slurped up about 1-3 pages from the docs site. So, I then read that maybe I could create a custom folder for this project and put it in the project’s /src folder like so: /src/nuxtui-docs and then I could use the @mention feature to tell the Cursor chat to use that folder as context.
Is this the right approach for using third-part docs? If so, can I keep the folder somewhere else besides in the /src folder? I did not see a way to use the @mention outside of the /src folder.
Just looking for best practices and most effective ways to use docs. Thank you.
I’ve been copy and pasting docs I need into .md files and then adding those files into the “add context” feature.
But I’ve been wondering about the exact same thing, is there a way to just add docs using the mention feature? Seems like adding docs via “mention” only takes one URL when docs could be spread over multiple URL’s
I think manually creating the files like you suggested seems to be the best method so far. Unless someone else has any other guidance, I’ll continue down that path.
In Cursor, you can show GPT-4 project documentation to improve it’s answers with @ commands like @Langchain and @Tokio. You can also spawn our crawler to add your own documentation by typing “@Add” in chat.
This repo is the list of documentation that’s available for all users of Cursor with no “@Add” command required.
I thought it might have given you some ‘behind-the-scenes’ insight into how the Docs symbol was working, and what URL syntax (and crawlerStart and crawlerPrefix values) were being used for the other ‘out-of-the-box’ docs.
Apologies if that wasn’t useful information.
Out of interest, what specific values are you putting in for the:
Prefix
Entrypoint
Below are some screenshots of what I see when I add some Docs in Cursor Settings > Features:
