apify-docs
Copilot instructions84 starsChanged 47 days agoApache-2.0View on GitHub
Read AGENTS.md in the repository root - it is the single source of truth for project architecture, commands, writing style, and terminology.
We split this copilot-instructions.md into the rules it gives an agent
6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 3
Read AGENTS.md in the repository root - it is the single source of truth for project architecture, commands, writing style, and terminology.
- Distinctive: line 8
All admonitions must have titles
- Distinctive: line 9
Use sentence case for headings, no gerunds (-ing forms)
- Distinctive: line 12
Use descriptive link text (never "click here")
- Distinctive: line 13
Always specify language for code blocks
- Distinctive: line 14
Follow Apify terminology: Actor, Console, Proxy, Store are capitalized.
≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
GitHub Copilot instructions for Apify documentation
Read AGENTS.md in the repository root - it is the single source of truth for project architecture, commands, writing style, and terminology.
Key points for Copilot
- API docs are generated from OpenAPI specs - never edit files in
apify-api/docs/directly - All admonitions must have titles
- Use sentence case for headings, no gerunds (-ing forms)
- Bold only for UI elements (buttons, menus, fields)
- Frontmatter required on all docs: title, description (140-160 chars), sidebar_position, slug
- Use descriptive link text (never "click here")
- Always specify language for code blocks
- Follow Apify terminology: Actor, Console, Proxy, Store are capitalized; task, schedule, dataset are lowercase
Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository9 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .cursor/rules/api-documentation.mdcCursor rule
- .cursor/rules/content-formatting.mdcCursor rule
- .cursor/rules/documentation-style.mdcCursor rule
- api-docSkill
- doc-writeSkill
- review-docsSkill
- tutorialSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

