Skip to content

Commit e178ecc

Browse files
docs: Refactor of Build with AI section
1 parent 1aa68f4 commit e178ecc

File tree

4 files changed

+514
-57
lines changed

4 files changed

+514
-57
lines changed

sources/platform/actors/development/quick_start/build_with_ai.md

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,29 @@ toc_max_heading_level: 4
1010

1111
---
1212

13-
import { RULES_AND_INSTRUCTIONS_PROMPT } from "@site/src/utils/ai-prompts";
13+
import { AGENTS_PROMPT } from "@site/src/utils/agents-prompt";
1414
import PromptButton from "@site/src/components/PromptButton";
1515

16-
This guide explains how to enhance your development workflow by leveraging `llms.txt` and `llms-full.txt` with an AI assistant. You will learn how to provide foundational context and further refine AI's behavior with specific rules and instruction files.
16+
This guide shows you how to build Actors efficiently with AI coding assistants. You'll learn how to use pre-built instructions, integrate Apify documentation into your AI editor, and apply best practices for AI-assisted development.
17+
18+
## AI coding assistant instructions
19+
20+
Use the following prompt in your favorite AI coding assistant:
21+
22+
<PromptButton prompt={AGENTS_PROMPT} title="Use pre-built prompt for your AI coding assistant" />
23+
24+
### Quick Start
25+
26+
- _Step 1_: Create directory: `mkdir my-new-actor`
27+
- _Step 2_: Open the directory in _Cursor_, _VS Code_, etc.
28+
- _Step 3_: Copy the prompt above and paste it into your AI coding assistant (Agent or Chat)
29+
- _Step 4_: Run it, and develop your first actor with the help of AI 🎉
30+
31+
:::info Start in an AI coding assistant
32+
33+
To maximize efficiency, copy the prompt to Cursor, VS Code with GitHub Copilot, or another AI coding assistant. The AI will follow the guide step-by-step, and you'll avoid copy-pasting from tools like ChatGPT or Claude.
34+
35+
:::
1736

1837
## `llms.txt` and `llms-full.txt`
1938

@@ -40,6 +59,8 @@ Search engines weren't built for Large Language Models (LLMs), but they needs co
4059
</tbody>
4160
</table>
4261

62+
<!-- TODO: Consider to remove it to keep it simple... -->
63+
4364
### Use llms.txt and llms-full.txt
4465

4566
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.
@@ -86,42 +107,17 @@ New to Apify? Ask questions and provide the `llms.txt` link. Popular AI models c
86107

87108
![Ask about Apify](./images/claude.png)
88109

89-
## View pages as markdown
90-
91-
Every page in Apify documentation is available in markdown format. Simply add `.md` to any documentation URL to access the raw markdown content.
110+
## Use Actor Templates with instructions
92111

93-
For example:
112+
TODO:
94113

95-
- [https://docs.apify.com/platform](https://docs.apify.com/platform)[https://docs.apify.com/platform.md](https://docs.apify.com/platform.md)
96-
- [https://docs.apify.com/api](https://docs.apify.com/api)[https://docs.apify.com/api.md](https://docs.apify.com/api.md)
114+
- Just mention that you can init actor using `apify create` and use it in IDE with AGENTS.md
97115

98-
This is useful when you want to:
116+
## Provide context to assistants
99117

100-
- Copy documentation content for AI prompts
101-
- Reference exact markdown syntax
102-
- Access content programmatically
118+
TBD:
103119

104-
## Add rules
105-
106-
To get the most from AI Code Editors, add rules or instructions.
107-
108-
See how to set up rules for your AI Code Editors:
109-
110-
- [Cursor Rules](https://docs.cursor.com/en/context/rules)
111-
- [Windsurf Rules](https://docs.windsurf.com/windsurf/cascade/memories#rules)
112-
- [GitHub Copilot instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions)
113-
114-
### Apify rules and instructions
115-
116-
The best rules and instructions are specific for individual use cases, but we provide a prompt to help you get start with creating rules and instructions:
117-
118-
<PromptButton prompt={RULES_AND_INSTRUCTIONS_PROMPT}/>
119-
120-
:::info Keep your rules and instructions up to date
121-
122-
As the project evolves, you might introduce new things. Always make sure that your rules and instructions are up to date.
123-
124-
:::
120+
- Mention "Copy for LLM" buttons
125121

126122
## Best practices
127123

src/components/PromptButton.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { useEffect, useRef, useState } from 'react';
22

3-
import { QUICK_START_PROMPT } from '../utils/ai-prompts';
3+
import { QUICK_START_PROMPT } from '../utils/quick-start-prompt';
44
import styles from './PromptButton.module.css';
55

66
export default function PromptButton({ prompt = QUICK_START_PROMPT, title = 'Use pre-built prompt to get started faster.' }) {

0 commit comments

Comments
 (0)