agentleFS
apifyapify/apify-docs/.github/copilot-instructions.md

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
  1. Distinctive:

    Read AGENTS.md in the repository root - it is the single source of truth for project architecture, commands, writing style, and terminology.

    line 3
  2. Distinctive:

    All admonitions must have titles

    line 8
  3. Distinctive:

    Use sentence case for headings, no gerunds (-ing forms)

    line 9
  4. Distinctive:

    Use descriptive link text (never "click here")

    line 12
  5. Distinctive:

    Always specify language for code blocks

    line 13
  6. Distinctive:

    Follow Apify terminology: Actor, Console, Proxy, Store are capitalized.

    line 14

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

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

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.