Skip to content

Commit 6fd41d6

Browse files
Refactor the docs
1 parent 225f767 commit 6fd41d6

File tree

6 files changed

+21
-49
lines changed

6 files changed

+21
-49
lines changed
Binary file not shown.
Binary file not shown.
113 KB
Loading
131 KB
Loading

sources/platform/actors/development/ai_assistant_coding/index.md

Lines changed: 21 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ slug: /actors/development/ai-assistants
1111

1212
### Documentation for LLMs: llms.txt and llms-full.txt
1313

14-
Search engines weren't built for Large Language Modals (LLMs). But AI needs context. That's why we created `llms.txt` and `llms-full.txt` for our documentation. These files follow the [growing standard](https://llmstxt.org/) for LLMs consumption.
14+
Search engines weren't built for Large Language Modals (LLMs), but AI needs context. That's why we created `llms.txt` and `llms-full.txt` for our documentation. These files follow the [growing standard](https://llmstxt.org/) for LLMs consumption.
1515

1616
Find them here:
1717

@@ -30,77 +30,49 @@ Find them here:
3030

3131
### Use llms.txt and llms-full.txt
3232

33-
LLMs don't automatically discover llms.txt files. You need to add the link manually. Some tools like Cursor provide settings for this.
33+
LLMs don't automatically discover llms.txt files, you need to add the link manually. Some tools like [Cursor](https://www.cursor.com/) provide settings for this.
3434

3535
#### Cursor
3636

37-
Go to: Settings -> Cursor Settings -> Indexing & Docs -> Add Doc.
37+
Go to: `Settings -> Cursor Settings -> Indexing & Docs -> Add Doc`.
3838

39-
Now, you can just provide the link to Apify `llms-full.txt`.
39+
Now, you can just provide the link to Apify `llms-full.txt`:
4040

41-
![Add llms-full.txt to Cursor](./images/cursor-docs.png)
42-
43-
#### Windsurf
41+
```markdown
42+
https://docs.apify.com/llms-full.txt
43+
```
4444

45-
- TODO...
45+
![Add llms-full.txt to Cursor](./images/cursor.png)
4646

47-
#### Visual Studio Code and Copilot
47+
#### Windsurf
4848

49-
Open Copilot Chat mode, and add context via `#fetch`:
49+
Open Windsurf Cascade, and add context via `@web`:
5050

51-
![Add llms.txt to Copilot](./images/copilot.png)
51+
![Add llms-full.txt to Windsurf](./images/windsurf.png)
5252

53-
:::note Copilot and llms.txt / llms-full.txt
53+
:::note Windsurf @docs
5454

55-
Copilot's official documentation doesn't cover llms.txt usage. If something doesn't work, check the official Apify documentation.
55+
Windsurf provides the `@docs` command, but you cannot customize it. It means that you cannot add your own documentation.
5656

5757
:::
5858

59-
#### Ask AI
60-
61-
New to Apify? Ask questions and provide the `llms.txt` link. Popular AI models can search the web. With the right context, you get better answers:
62-
63-
![Ask about Apify](./images/claude.png)
64-
65-
### Use Modal Context Protocol (MCP)
59+
#### GitHub Copilot
6660

67-
Context is everything with LLMs. You can add `llms.txt` and `llms-full.txt`. But there are limitations, as we mentioned with Copilot. Another way to provide context is through Modal Context Protocol (MCP) and Context7.
68-
69-
#### Context7
70-
71-
Context7 MCP pulls up-to-date documentation and code examples from the source. It places them directly into your prompt. Find more information on the [Context7](https://context7.com/) website.
72-
73-
#### Install Context7
74-
75-
Go to: Settings -> Cursor Settings -> Tools & Integrations -> New MCP Server
61+
Open Copilot Chat mode, and add context via `#fetch`:
7662

77-
Add this configuration to your `mcp.json` file:
63+
![Add llms.txt to Copilot](./images/github-copilot.png)
7864

79-
```json
80-
{
81-
"mcpServers": {
82-
"context7": {
83-
"url": "https://mcp.context7.com/mcp"
84-
}
85-
}
86-
}
87-
```
65+
:::note GitHub Copilot and documentation
8866

89-
:::tip Check official guides for other IDEs
90-
91-
Find a guide for your favorite IDE on the [official installation page](https://github.com/upstash/context7?tab=readme-ov-file#%EF%B8%8F-installation).
67+
Similar to Windsurf, GitHub Copilot does not provide an option for adding your own documentation.
9268

9369
:::
9470

95-
#### Use Context7
96-
97-
Context7 fetches up-to-date code examples and documentation into your LLM's context.
71+
#### Ask AI
9872

99-
- Write your prompt naturally
100-
- Tell the LLM to use context7
101-
- Get working code answers
73+
New to Apify? Ask questions and provide the `llms.txt` link. Popular AI models can search the web. With the right context, you get better answers:
10274

103-
![Apify and Context7](./images/context7.png)
75+
![Ask about Apify](./images/claude.png)
10476

10577
### Add rules
10678

0 commit comments

Comments
 (0)