Use Documentation

Support Help
1

Hi there, I have been playing with Cursor Use Documentation.

I added a number of links in the doc settings and I try asking to the chat if it can come up with some of the code snippets in my docs.

The results are completely random, and doesn’t seems like understanding the docs at all.
I wonder if I am doing something wrong or there are limitations of this kind.

Thanks!

1 Like
2

Hey, can you describe what steps you took and what you got in response?

3

Sure thing

I added the following links on cursor doc settings
see image

Screenshot 2025-02-04 at 9.47.11 AM
Screenshot 2025-02-04 at 9.47.11 AM864×332 27.6 KB

  1. Git cloned one of these
    GitHub - Snapchat/Spectacles-Sample: Spectacles Sample Projects
  2. Opened 1 script using cursor
  3. Asked for a camera API code snippet
    Desired similar output from camera module documentation
@component
export class ContinuousCameraFrameExample extends BaseScriptComponent {
  private cameraModule: CameraModule = require('LensStudio:CameraModule');
  private cameraRequest: CameraModule.CameraRequest;
  private cameraTexture: Texture;
  private cameraTextureProvider: CameraTextureProvider;

  @input
  @hint('The image in the scene that will be showing the captured frame.')
  uiImage: Image | undefined;

  onAwake() {
    this.createEvent('OnStartEvent').bind(() => {
      this.cameraRequest = CameraModule.createCameraRequest();
      this.cameraRequest.cameraId = CameraModule.CameraId.Default_Color;

      this.cameraTexture = this.cameraModule.requestCamera(this.cameraRequest);
      this.cameraTextureProvider = this.cameraTexture
        .control as CameraTextureProvider;

      this.cameraTextureProvider.onNewFrame.add((cameraFrame) => {
        if (this.uiImage) {
          this.uiImage.mainPass.baseTex = this.cameraTexture;
        }
      });
    });
  }
}

code result is very inaccurate

from camera_api import CameraModule, CameraRequest, CameraType

# Initialize the CameraModule
camera_module = CameraModule()

# Create a CameraRequest for the desired camera and resolution
camera_request = CameraRequest(
    camera_type=CameraType.Left_Color,  # Choose from Left_Color, Right_Color, or SystemDefault_Color
    image_smaller_dimension=640  # Specify the smallest dimension in pixels
)

# Start receiving frames
camera_module.start_receiving_frames(camera_request)

# Callback function to handle received frames
def on_frame_received(frame):
    # Process the frame (e.g., display or save it)
    print("Received a frame with resolution:", frame.resolution)

# Register the callback
camera_module.set_frame_received_callback(on_frame_received)

# Stop receiving frames when done
# camera_module.stop_receiving_frames()

would it be better adding links of this kind?

would it be effective adding a repo as a link?

4

Additionally is there any guideline for having a website ai - crawl friendly using cursor?

5

Hey, to confirm, did you @ the docs into your query when you submitted it?

Also, no guide right now on how to make them crawler friendly, but could be a good one to add to docs.cursor.com

6

Thanks for getting back to me.

I did not @ the docs as I assumed that indexing in the settings was enough.
How would I @ the docs? what if I have like 10 of them, how would I go about it?

To put into an example, so let’s say

1.But I am expecting cursor to guess something as the information has been recursively indexed?

You can run a test yourself if you’d like

2.What is the recommended docs/links I should index and how would I make my prompt more efficient?
3.Should I use large context?
4.Should I use composer?
5.Can I insert like a repo of samples where I know there is quite significant code to my project? Is that effective?

Thanks

7

You can @ a whole doc and Cursor will find relevant sections, but can’t @ specific pages yet - you can paste specific links though and Cursor will look at those

For your specific questions:

  1. Cursor does look through docs intelligently to find relevant sections for the AI
  2. Try using https://developers.snap.com/api/home as the base URL (remove /home from prefix) so Cursor knows what pages to index
  3. Large context can help but uses more fast requests - up to you if needed
  4. Definitely use Composer, it’s the most powerful feature we have
  5. Instead of adding repos directly, open it in Cursor and use Composer to write a markdown file explaining the structure - then use that as context in your own Composer
2 Likes