docs: fix medium-severity inaccuracies in Actors pages#2726
Open
mtrunkat wants to merge 5 commits into
Open
Conversation
Corrects labels, values, and descriptions across 26 Actors pages to match platform behavior, and documents previously undocumented fields/behaviors (e.g. ACTOR_MAX_PAID_DATASET_ITEMS, APIFY_PROXY_HOSTNAME, systemInfo event, subscription-plan memory cap). High-severity card-link and pay-per-result fixes on programming_interface/index.mdx and running/store/index.md are handled in the Actors high-severity PR.
Contributor
|
✅ Preview for this PR (commit |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Apify Actors documentation pages to correct audited medium-severity inaccuracies, primarily aligning UI labels, platform behaviors, and technical details with the current Apify Console and runtime behavior.
Changes:
- Updates Console/UI terminology and flows (e.g., Endpoints tab, Live view URL, API dropdown steps, review/report field labels).
- Refreshes technical/platform specifics (run/build origins including
CIandMCP, system events payloads, encryption cipher name, dataset validation response details, default Dockerfile example, new environment variables). - Aligns publishing/monetization docs (Insights dashboard naming/URL, payout thresholds, unit-cost table additions, deprecation automation timeline, task publishing limits).
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sources/platform/actors/running/store/reviews.mdx | Updates the review reporting UI field label. |
| sources/platform/actors/running/runs_and_builds.md | Adds new Origin values and updates resurrection terminal status terminology. |
| sources/platform/actors/running/actor_standby.md | Renames Standby UI references to Endpoints and documents default configuration behavior. |
| sources/platform/actors/publishing/testing.mdx | Updates automated test expectations (status requirement). |
| sources/platform/actors/publishing/publish.mdx | Updates the publish button label text to match Console. |
| sources/platform/actors/publishing/publish-task.mdx | Clarifies the limit as “public tasks” rather than tasks in general. |
| sources/platform/actors/publishing/monetize/pricing_and_costs.mdx | Adds Web Unblocker unit-cost row to the pricing table. |
| sources/platform/actors/publishing/monetize/index.mdx | Updates payout thresholds and replaces Analytics wording with Insights dashboard info. |
| sources/platform/actors/publishing/index.mdx | Updates monetization model wording and adds a rental sunsetting partial. |
| sources/platform/actors/publishing/actor-status.mdx | Clarifies the automated deprecation timeline based on failing tests. |
| sources/platform/actors/publishing/actor-rating.mdx | Updates “edit reply” UI action text. |
| sources/platform/actors/development/quick-start/start_locally.md | Fixes cd command formatting in the quick start. |
| sources/platform/actors/development/programming_interface/system_events.md | Updates/extends system event definitions and payload structure documentation. |
| sources/platform/actors/development/programming_interface/index.mdx | Fixes the “Basic commands” card description to match its contents. |
| sources/platform/actors/development/programming_interface/environment_variables.md | Adds new documented env vars for pay-per-result and proxy hostname. |
| sources/platform/actors/development/programming_interface/container_web_server.md | Renames Container URL to Live view URL to match Console. |
| sources/platform/actors/development/performance.md | Updates the caching example base image version. |
| sources/platform/actors/development/index.md | Fixes an internal link to the Performance section. |
| sources/platform/actors/development/deployment/source_types.md | Clarifies dockerContextDir behavior for monorepos. |
| sources/platform/actors/development/deployment/continuous_integration.md | Updates Console navigation for finding API endpoints. |
| sources/platform/actors/development/actor_definition/web_server_schema/index.md | Renames Standby tab references to Endpoints tab in schema docs. |
| sources/platform/actors/development/actor_definition/output_schema/index.md | Corrects output schema API keying note and updates consoleRunUrl format. |
| sources/platform/actors/development/actor_definition/input_schema/secret_input.md | Updates the documented cipher for secret input encryption. |
| sources/platform/actors/development/actor_definition/dynamic_actor_memory/index.md | Documents subscription-plan max-memory capping behavior. |
| sources/platform/actors/development/actor_definition/docker.md | Updates the documented default Dockerfile (base image + simplified steps). |
| sources/platform/actors/development/actor_definition/dataset_schema/validation.md | Documents fieldStatistics presence in successful dataset validation responses. |
| sources/platform/actors/development/actor_definition/actor_json.md | Updates README discovery order (adds .actor/ACTOR.md and README without extension). |
| |`SCHEDULER`|Using a schedule| | ||
| |`WEBHOOK`|Using a webhook| | ||
| |`ACTOR`|From another Actor run| | ||
| |`STANDBY`|From [Actor Standby](./standby)| |
| | Event name | Payload | Description | | ||
| | --- | --- | --- | | ||
| | `cpuInfo` | `{ isCpuOverloaded: Boolean }` | Emitted approximately every second, indicating whether the Actor is using maximum available CPU resources. | | ||
| | `systemInfo` | `{ memAvgBytes, memCurrentBytes, memMaxBytes, cpuAvgUsage, cpuMaxUsage, cpuCurrentUsage: Float, isCpuOverloaded: Boolean }` | Emitted approximately every second with the run's current memory and CPU usage statistics. | |
Revert the code-point re-alignment of the emoji-headed table (markdownlint MD060 measures visual width); keep only the prose fix on this page.
Member
Author
|
@mvolfik could you take a look at this one? It's mostly relevant for core services. I was trying to use Claude for discrepancies between the docs and reality. For example, the Standby tab was renamed, some wrong status messages were found, etc. |
mvolfik
approved these changes
Jul 10, 2026
| | ~~`APIFY_HEADLESS`~~ | _Deprecated_ - on the Apify platform this is always set to **1**, so web browsers inside the Actor always run in headless mode (no windowing system available). | | ||
| | Environment variable | Description | | ||
| |----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `APIFY_TOKEN` | API token of the user who started the Actor. | |
Member
There was a problem hiding this comment.
nit: should we describe here that it's not a token of the user, but rather a run token, potentially with scoped (limited) permissions?
| | `APIFY_PROXY_HOSTNAME` | Hostname of the Apify Proxy to use when building a proxy connection string. | | ||
| | `APIFY_PROXY_PORT` | TCP port number to be used for connecting to Apify Proxy. | | ||
| | `APIFY_PROXY_STATUS_URL` | URL for retrieving proxy status information. Appending `?format=json` to this URL returns the data in JSON format for programmatic processing. | | ||
| | `APIFY_API_PUBLIC_BASE_URL` | Public URL of the Apify API. May be used to interact with the platform programmatically. Typically set to `api.apify.com`. | |
Member
There was a problem hiding this comment.
nit (this doesn't matter much for public docs, though), but this URL is rather intended for exporting public URLs (links to key-value stores etc). For interacting with the platform, it's the APIFY_API_BASE_URL https://github.com/apify/apify-shared-js/blob/master/packages/consts/src/consts.ts#L274 (which I understand could be some k8s internal IP, for more direct routing? not sure if we do that)
this only really matters on dev-stack, though - there, public base URL is localhost:3333, while the internal one needs to be host.docker.internal. idk how much of this we want to spell out in docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects medium-severity discrepancies across 26 Actors pages found by auditing the docs against the platform source (
apify-core,apify-worker). Highlights:actor-node:20, simplified) and cache-example base image;aes-256-gcm->aes-256-ctrfor secret input;readmesearch order; PayPal/Wise payout thresholds.fieldStatisticsin the 201 response; subscription-plan memory cap step;systemInfoevent andpersistState.isAborting; run/build origins (CI,MCP); resurrection terminal stateSUCCEEDED; Standby default configuration in Settings.ACTOR_MAX_PAID_DATASET_ITEMS,APIFY_PROXY_HOSTNAME; new Web Unblocker unit-cost row; Insights dashboard replacing the removed Analytics tab.Note: the high-severity card-link and pay-per-result fixes that also touch
programming_interface/index.mdxandrunning/store/index.mdare in the companion Actors high-severity PR.Generated by Claude Code