Skip to content

docs: Add requirements for publishing Actors #3105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szaganek merged 5 commits into from
Oct 23, 2026
Merged

docs: Add requirements for publishing Actors #3105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
987f65d
docs: Add requirements for publishing Actors
szaganek Oct 22, 2026
dd9cb35
apply feedback suggestions
szaganek Oct 23, 2026
ce16250
Merge branch 'master' into publishing-gates
szaganek Oct 23, 2026
9434db5
fix broken link
szaganek Oct 23, 2026
c9c6fd2
update the frontmatter
szaganek Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sources/platform/actors/publishing/publish/actor-readme.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: Create an Actor README
description: Learn how to create a README for your Actor.
description: Create a README that attracts new users and supports existing ones. Optimize for search engines and AI assistants, document usage, and cover common issues.
slug: /actors/publishing/actor-readme
sidebar_position: 1
---

The README file becomes your Actor's public detail page on Apify Store. It's where users and agents can learn about your Actor and how to use it.

Your Actor's README has four functions:

- First impression. Your README is one of the first points of contact with a potential user. If you come across as convincing, clear, and reassuring it could be the factor that makes a user try your Actor.
Expand Down
11 changes: 8 additions & 3 deletions sources/platform/actors/publishing/publish/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Publish your Actor
description: Prepare your Actor for publication on Apify Store.
description: Publish your Actor on Apify Store, where anyone can discover and use it. Learn about the publishing requirements and choose whether to share its source code.
slug: /actors/publishing/publish
sidebar_position: 1
---
Expand All @@ -9,9 +9,14 @@ By publishing your Actor, you make it available to the public on [Apify Store](h

## Before you start

Before you publish your Actor, update its README file. The README becomes your Actor's public detail page on Apify Store. It's where users can learn about your Actor and how to use it.
To publish an Actor on Apify Store, you must first:

For details, see [Create an Actor README](/actors/publishing/actor-readme).
- Accept the [Store Publishing Terms and Conditions](/legal/store-publishing-terms-and-conditions).
- Build and run your Actor at least once.
- Update your [Actor README](/actors/publishing/actor-readme).
- Define the [input](/actors/development/actor-definition/input-schema) and [output](/actors/development/actor-definition/output-schema) schemas of your Actor.

If your Actor requires [full permissions](/actors/development/permissions), or you want to publish more than 10 Actors, you must also [verify your identity](/actors/monetize/monthly-payouts#verify-your-identity).

## Make your Actor public

Expand Down
Loading