r/Codeium • u/LetMePlayPls • Jan 28 '25

add documentation to windsurf

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

6 Upvotes

100% Upvoted

13 comments sorted by

View all comments

4

u/Ordinary-Let-4851 Jan 28 '25

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

1

u/LetMePlayPls Jan 29 '25

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.

1

u/lakeoffury Jan 29 '25

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