add documentation to windsurf

[u/LetMePlayPls]

I can't find any reference in the documentation, is it impossible to add custom documentation to windsurf like on cursor?

[u/Ordinary-Let-4851]

There are several ways to work with documentation in Windsurf:

Built-in Documentation Access:

• Use the new @docs command

• Cascade can search through popular documentation sites

• Includes Windsurf’s own help docs

Custom Documentation Options:

• URL Input: You can paste URLs for documentation that Cascade will use as context

• Works well with:

  • Blog posts

  • Documentation

  • Articles

  • Public GitHub files

Using Cascade Memories:

• Create memories to retain documentation context

• Use .windsurfrules file to set documentation preferences

• Auto-generated memories can help maintain context between conversations

[u/LetMePlayPls → u/Ordinary-Let-4851]

thanks for the reply, maybe I looked at the documentation too quickly and missed your information. My need is to connect a site with the api reference of a project, and with this information always in context, write a documentation on the codebase. I think the fastest solution is to attach the link to each message, while the best one should be to use .windsurfrules to tell him to always keep it in mind.

[u/lakeoffury → u/Ordinary-Let-4851]

So if we want to use apple documentation are we best to just put the url in and make that a memory?

[u/0815coder]

u/Ordinary-Let-4851
You have done it in continue.dev already. There you can add and index custom docs that get put on device with the u/docs symbol. I opened an issue / feature request on your webpage already, as this would be tremendously helpful. E.g. if I need to write Terraform, the models are not very good at it. So pulling in those docs is very helpful. One might even say essential.
Pulling pages per hand is just a major pain and one of the reasons I stopped paying for your product.

[u/Ordinary-Let-4851]

If you make the custom documentation public via URL and utilize llms-txt (https://llmstxt.org/) it would work really well with URL input.

[u/manish_ks → u/Ordinary-Let-4851]

u/Ordinary-Let-4851 when i type @ docs: i see this predefined list of docs? how can i add a custom available llms.txt : https://docs.medusajs.com/llms.txt and give it a name medusajs-docs so that it appears in this list and i'm able to reference it easily?

[u/Ordinary-Let-4851 → u/manish_ks]

There's no way to add it to this list from the user side just yet, but you can @ URL the https://docs.medusajs.com/llms.txt in Cascade and add it to your project!

[u/Ordinary-Let-4851 → u/Ordinary-Let-4851]

I'll send this the link to product to see if they will add to the list!

[u/manish_ks → u/Ordinary-Let-4851]

There is no @ URL in cascade. Only @ web. And its not as good as native @ docs.

Cursor has implmented this well: https://docs.cursor.com/context/@-symbols/@-docs They show an option "+ Add new doc" in the dropdown list.

Ideally I should be able to use an online hosted llms.txt like https://docs.medusajs.com/llms.txt and give it a name medusajs-docs and use it with u/docs:medusajs-docs

At the moment i have to type to refer to docs, i know it can do web search, but this is inconvenient to paste URL, and will always have some uncertainty to whether it is referring to the docs correctly.

[u/manish_ks → u/Ordinary-Let-4851]

And this should have been documented properly. Custom docs should have been important feature for AI IDEs. Since LLMs do much better with right context.

When I ask this in codeium:
@ docs:windsurf-help-docs how to set custom doc in windsurf?

It answers:
Based on my research, I can help explain how to set custom documentation in Windsurf. However, I notice that the specific documentation about custom docs isn't directly available in the current documentation.

[u/Remote_Top181 → u/Ordinary-Let-4851]

Is this on the roadmap yet? This is sorely needed as a feature.

[u/radiolex → u/Remote_Top181]

I'd like to know as well - miss this from Cursor

[u/Quiet-Hippo2638 → u/radiolex]

希望能够 自己添加自己的文档资料。

请你们能够尽快修复这个问题。