-
Notifications
You must be signed in to change notification settings - Fork 179
feat: Fixing docs vs actual product disprepancies #2345
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.
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # Documentation vs Console discrepancies | ||
|
Check failure on line 1 in docs-vs-console-discrepancies.md
|
||
|
|
||
| Audit performed on 2026-03-20 against local Apify Console at localhost:3000. | ||
|
|
||
| ## 1. Console homepage: "Homepage" vs "Dashboard" | ||
|
|
||
| **File**: `sources/platform/console/index.md` | ||
|
|
||
| - **Docs say**: Section heading "Homepage overview", references the page as "homepage" | ||
| - **Actual Console**: The page heading is "Dashboard" and the sidebar item is "Dashboard" | ||
| - **Docs keyboard shortcut**: Lists "Home" with shortcut GH | ||
| - **Actual**: The sidebar says "Dashboard", not "Home" | ||
| - **Fix**: Rename "Homepage overview" to "Dashboard overview", update references to use "Dashboard" | ||
|
|
||
| ## 2. Console navigation: missing "Dashboard" sidebar item | ||
|
Check failure on line 15 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/console/index.md` | ||
|
|
||
| - **Docs**: The navigation table (lines 111-123) does not include "Dashboard" as a sidebar item | ||
| - **Actual**: "Dashboard" is a sidebar item at `/`, positioned between "Apify Store" and "Actors" | ||
| - **Fix**: Add "Dashboard" row to the navigation table | ||
|
|
||
| ## 3. Sign-up/sign-in buttons: wrong button labels | ||
|
Check failure on line 23 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/console/index.md` | ||
|
|
||
| - **Docs say**: "Sign up with Google" / "Sign up with GitHub" buttons | ||
| - **Actual**: Buttons say "Continue with Google" / "Continue with GitHub" | ||
| - **Docs say**: References "sign-in" throughout | ||
| - **Actual**: The page heading says "Log in to Apify" | ||
| - **Fix**: Update button labels to match actual UI | ||
|
|
||
| ## 4. Settings tab name: "Integrations" vs "API & Integrations" | ||
|
|
||
| **File**: `sources/platform/console/settings.md` | ||
|
|
||
| - **Docs say**: "The **Integrations** tab" | ||
| - **Actual**: The tab is called "**API & Integrations**" | ||
| - **Fix**: Update tab name to "API & Integrations" | ||
|
|
||
| ## 5. Settings: missing "Referrals" tab | ||
|
Check failure on line 41 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/console/settings.md` | ||
|
|
||
| - **Docs**: Do not mention the "Referrals" tab at all | ||
| - **Actual**: There is a "Referrals" tab in Settings, positioned after "Notifications" | ||
| - **Fix**: Add a section describing the Referrals tab | ||
|
|
||
| ## 6. Settings: "API & Integrations" content description outdated | ||
|
|
||
| **File**: `sources/platform/console/settings.md` | ||
|
|
||
| - **Docs say**: Mentions "Slack workspace" integration specifically and "Actor Integration Accounts" | ||
| - **Actual**: The tab shows "API tokens" section, "Third-party apps & services", "Account-level integrations" with generic "Add account" button, and "Actor OAuth accounts" | ||
| - **Fix**: Update description to match actual sections | ||
|
|
||
| ## 7. Billing tab name: "Subscriptions" vs "Subscription" | ||
|
|
||
| **File**: `sources/platform/console/billing.md` | ||
|
|
||
| - **Docs say**: "The **Subscriptions** tab" | ||
| - **Actual**: The tab is called "**Subscription**" (singular) | ||
| - **Fix**: Change "Subscriptions" to "Subscription" | ||
|
|
||
| ## 8. Schedules: outdated Console URLs | ||
|
Check failure on line 65 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/schedules.md` | ||
|
|
||
| - **Docs reference**: `https://console.apify.com/account?tab=integrations` for secret API token | ||
| - **Docs reference**: `https://console.apify.com/account#/integrations` for user ID | ||
| - **Actual**: The correct URL is `https://console.apify.com/settings/integrations` | ||
| - **Fix**: Update URLs to point to correct settings path | ||
|
|
||
| ## 9. Actors page: "Pay per usage" pricing label not documented | ||
|
|
||
| **File**: `sources/platform/actors/running/store.md` | ||
|
|
||
| - **Docs say**: Three pricing models: "Pay per event", "Pay per result", "Rental" | ||
| - **Actual Console**: Some Actors show "Pay per usage" as their pricing model label in the Actors table | ||
| - **Note**: "Pay per usage" appears to be the standard platform-usage-only pricing model (no additional per-event or per-result charges). The docs only describe the three store-specific pricing models but don't mention the "Pay per usage" label that appears in Console. | ||
| - **Fix**: Add note about "Pay per usage" as the default model for Actors that only charge platform usage costs | ||
|
|
||
| ## 10. Settings: "Login & Privacy" tab not separately described | ||
|
|
||
| **File**: `sources/platform/console/settings.md` | ||
|
|
||
| - **Docs**: Mention "Login & Privacy" in an info box but list login info under the Account section bullet points | ||
| - **Actual**: "Login & Privacy" is its own separate tab (distinct from "Account"), containing sign-in methods, password reset, two-factor authentication, and session configuration | ||
| - **Fix**: Restructure to describe Login & Privacy as its own section/tab | ||
|
|
||
| ## 11. Widespread outdated `/account` URLs across the codebase | ||
|
|
||
| **Affected files** (30+ files): | ||
|
|
||
| - Multiple integration docs reference `console.apify.com/account?tab=integrations`, `console.apify.com/account#/integrations`, or `console.apify.com/account/integrations` | ||
| - Organization docs reference `console.apify.com/account#/myorganizations` and `console.apify.com/account#/myorganization` | ||
| - Storage docs, monitoring docs, academy docs, and API reference docs all contain old URLs | ||
| - **Actual**: Settings is at `console.apify.com/settings/integrations`, organizations at `console.apify.com/settings/organizations` | ||
| - **Fix**: Updated all occurrences across the codebase | ||
|
|
||
| ## 12. Widespread "Settings > Integrations" instead of "Settings > API & Integrations" | ||
|
|
||
| **Affected files** (20+ files): | ||
|
|
||
| - Many integration docs (Make, n8n, Gumloop, Telegram, Slack, Keboola, etc.) refer to the tab as "Settings > Integrations" in prose text | ||
| - **Actual**: The Settings tab is called "API & Integrations" | ||
| - **Fix**: Updated text references to "Settings > API & Integrations" across all affected files | ||
|
|
||
| --- | ||
|
|
||
| ## Second-round findings (step-by-step tutorial walkthrough) | ||
|
|
||
| ## 13. Actor running tutorial: wrong button labels | ||
|
Check failure on line 113 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/actors/running/index.md` | ||
|
|
||
| - **Docs say**: "click **Use Actor**" then "click **Save & Start**" | ||
| - **Actual Console**: There is no "Use Actor" button on the Actor detail page. The run button says **"Start"**, not "Save & Start" | ||
| - **Fix**: Updated to remove "Use Actor" reference and changed "Save & Start" to "Start" | ||
|
|
||
| ## 14. Actor tasks: wrong "Create task" button label | ||
|
Check failure on line 121 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/actors/running/tasks.md` | ||
|
|
||
| - **Docs say**: "click the **Create task** button" | ||
| - **Actual Console**: The button says **"Save as a new task"** | ||
| - **Fix**: Updated button label | ||
|
|
||
| ## 15. Schedules: wrong "Add" button label and nonexistent "Save & activate" | ||
|
Check failure on line 129 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/schedules.md` | ||
|
|
||
| - **Docs say**: "Click on the **Add** dropdown" | ||
| - **Actual Console**: Button says **"Add new"** | ||
| - **Docs say**: "click **Save & activate**" | ||
| - **Actual Console**: No such button exists. Schedules are created in an enabled state; you toggle with **Disable**/**Enable** button | ||
| - **Fix**: Updated button label and replaced "Save & activate" description | ||
|
|
||
| ## 16. Dataset detail: outdated export flow description | ||
|
Check failure on line 139 in docs-vs-console-discrepancies.md
|
||
|
|
||
| **File**: `sources/platform/storage/dataset.md` | ||
|
|
||
| - **Docs say**: "Select the format in **Export dataset** section" then "Click **Download**" | ||
| - **Actual Console**: There is an **Export** button (not an "Export dataset" section), and data can be viewed in **Table** or **JSON** format. There is no separate **Download** button. | ||
| - **Fix**: Updated the export flow to match actual UI | ||
|
|
||
| ## 18. Web IDE guide: wrong intro paragraph | ||
|
|
||
| **File**: `sources/platform/actors/development/quick-start/start_web_ide.md` | ||
|
|
||
| - **Docs say**: "You'll start by creating and running it locally with the Apify CLI" | ||
| - **Actual**: This guide is about the Web IDE, not the CLI. The intro was copied from the local development guide. | ||
| - **Fix**: Rewrote the intro to accurately describe the Web IDE workflow | ||
|
|
||
| ## 19. Web IDE guide: outdated template name and New Actor page layout | ||
|
|
||
| **File**: `sources/platform/actors/development/quick-start/start_web_ide.md` | ||
|
|
||
| - **Docs say**: "templates for JavaScript, TypeScript, and Python" and "proceed with **Crawlee + Puppeteer + Chrome**" | ||
| - **Actual New Actor page**: Shows three sections - "Link a Git repository", "Select a code template", and "Push your code with Apify CLI". The default templates shown are "Crawlee + Cheerio" variants, not "Crawlee + Puppeteer + Chrome" | ||
| - **Fix**: Updated to describe the actual page layout and use "Crawlee + Cheerio" template name | ||
|
|
||
| ## 20. Web IDE guide: minor tab capitalization | ||
|
|
||
| **File**: `sources/platform/actors/development/quick-start/start_web_ide.md` | ||
|
|
||
| - **Docs say**: "Last Run" (capitalized R) | ||
| - **Actual**: Tab says "Last run" (lowercase r) | ||
| - **Fix**: Updated to "Last run" | ||
|
|
||
| ## 21. Builds doc: wrong button label "Start" instead of "Build" | ||
|
|
||
| **File**: `sources/platform/actors/development/builds_and_runs/builds.md` | ||
|
|
||
| - **Docs say**: "Locate the **Start** button. Next to it, click on the arrow & choose **Clean build**" | ||
| - **Actual Console**: The button says **"Build"**, not "Start" | ||
| - **Fix**: Updated "Start" to "Build" | ||
|
|
||
| ## 22. General resource access: wrong settings tab name | ||
|
|
||
| **File**: `sources/platform/collaboration/general-resource-access.md` | ||
|
|
||
| - **Docs say**: "Settings → Security & Privacy" | ||
| - **Actual Console**: For personal accounts, the tab is **"Login & Privacy"** (not "Security & Privacy") | ||
| - Also docs say "Account Settings → Privacy" for run sharing - actual is "Settings → Login & Privacy → Share run data with developers" | ||
| - **Fix**: Updated both references | ||
|
|
||
| ## 23. Google Drive integration: wrong integration name | ||
|
|
||
| **File**: `sources/platform/integrations/data-storage/drive.md` | ||
|
|
||
| - **Docs say**: click on the **"Upload file"** integration | ||
| - **Actual Console**: The integration is called **"Upload results to GDrive"** | ||
| - **Fix**: Updated integration name | ||
|
|
||
| ## 24. Gmail integration: wrong integration name | ||
|
|
||
| **File**: `sources/platform/integrations/workflows-and-notifications/gmail.md` | ||
|
|
||
| - **Docs say**: "click on Send email generic integration" | ||
| - **Actual Console**: The integration is called **"Send results email via Gmail"** | ||
| - **Fix**: Updated integration name | ||
|
|
||
| ## 17. Actor detail page: tabs don't match documentation structure | ||
|
|
||
| **Observed in Console** (for own Actors in development mode): | ||
|
|
||
| Main tabs: Source, Information, Runs, Builds, Integrations, Monitoring, Issues, Saved tasks, Settings, Publication | ||
|
|
||
| Inner source tabs: Code, Last build, Input, Last run | ||
|
|
||
| This differs from what's implied in the running tutorial docs, which describe a simpler view with just Input/Output tabs. The development mode view has a significantly different tab structure than the store Actor view. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; | |
|
|
||
| ## What you'll learn | ||
|
|
||
| This guide walks you through the full lifecycle of an Actor. You'll start by creating and running it locally with the Apify CLI, then learn to configure its input and data storage. Finally, you will deploy the Actor to the Apify platform, making it ready to run in the cloud. | ||
| This guide walks you through the full lifecycle of an Actor using the web IDE in Apify Console. You'll create an Actor from a code template, build it, configure its input, and run it in the cloud. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
|
|
@@ -22,9 +22,9 @@ Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors** | |
|
|
||
|  | ||
|
|
||
| You'll see Actor development templates for `JavaScript`, `TypeScript`, and `Python`. | ||
| You'll see options to link a Git repository, select a code template, or push code with the Apify CLI. | ||
|
|
||
| These templates provide boilerplate code and a preconfigured environment. Choose the template that best suits your needs. For the following demo, we'll proceed with **Crawlee + Puppeteer + Chrome**. | ||
| Under **Select a code template**, you'll find quick-start templates for TypeScript, Python, and JavaScript. Click **Browse all templates** to see the full list. Choose the template that best suits your needs. For the following demo, we'll proceed with a **Crawlee + Cheerio** template. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth adding which version of a Crawlee + Cheerio template we're using. TypeScript or JavaScript? 🤔 |
||
|
|
||
| :::info Explore Actor templates | ||
|
|
||
|
|
@@ -65,7 +65,7 @@ The UI includes four tabs: | |
| - **Code** | ||
| - **Last build** | ||
| - **Input** | ||
| - **Last Run** | ||
| - **Last run** | ||
|
|
||
| This represents the Actor creation flow, where you first build the Actor from the source code. Once the build is successful, you can provide input parameters and initiate an Actor run. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,11 +34,11 @@ For this tutorial, let's choose [Website Content Crawler](https://console.apify. | |
|
|
||
| ### 2. Configure and run your Actor | ||
|
|
||
| Once you select the Actor, click **Use Actor**. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This button is used for the new UI; beware. |
||
| Once you select the Actor, you will be taken to the Actor's detail page. | ||
|
|
||
| In the **Input** tab, you can customize your Actor's behavior. Website Content Crawler is pre-configured to run without extra input, so you don't need to change anything. | ||
|
|
||
| To run the Actor, click **Save & Start**. | ||
| To run the Actor, click **Start**. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -18,8 +18,9 @@ import RentalSunset from '../../../_partials/_rental-sunsetting.mdx'; | |||||
|
|
||||||
| ## Pricing models | ||||||
|
|
||||||
| All Actors in [Apify Store](https://apify.com/store) fall into one of three pricing models: | ||||||
| Actors in [Apify Store](https://apify.com/store) use one of the following pricing models: | ||||||
|
|
||||||
| 1. [**Pay per usage**](#pay-per-usage) - you only pay for the platform resources (compute units, data transfer, etc.) the Actor consumes. There are no additional charges from the Actor developer. This is shown as "Pay per usage" in Apify Console. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We know it's called "Pay per usage" from the first sentence.
Suggested change
|
||||||
| 1. [**Pay per event**](#pay-per-event) - you pay for specific events the Actor creator defines, such as generating a single result or starting the Actor. Most Actors include platform usage in the price, but some may charge it separately - check the Actor's pricing for details. | ||||||
| 1. [**Pay per result**](#pay-per-result) - you do not pay for platform usage the Actor generates and instead just pay for the results it produces. | ||||||
| 1. [**Rental**](#rental-actors) - to continue using the Actor after the trial period, you must rent the Actor from the developer and pay a flat monthly fee in addition to the costs associated with the platform usage that the Actor generates. | ||||||
|
|
@@ -28,6 +29,10 @@ All Actors in [Apify Store](https://apify.com/store) fall into one of three pric | |||||
| After a run finishes, any interactions with the dataset - such as reading or writing additional data - incur standard platform usage costs. This applies to all pricing models. Unnamed datasets are automatically removed after your data retention period, so long-term storage is rarely a concern. | ||||||
| ::: | ||||||
|
|
||||||
| ### Pay per usage | ||||||
|
|
||||||
| With pay per usage pricing, you only pay for the platform resources the Actor consumes - compute units, data transfer, proxy, and storage. The Actor developer does not charge any additional fees. This is the default pricing model for most Actors, especially private Actors and many community-built Actors in Apify Store. | ||||||
|
||||||
| With pay per usage pricing, you only pay for the platform resources the Actor consumes - compute units, data transfer, proxy, and storage. The Actor developer does not charge any additional fees. This is the default pricing model for most Actors, especially private Actors and many community-built Actors in Apify Store. | |
| With pay per usage pricing, you only pay for the platform resources the Actor consumes - compute units, data transfer, proxy, and storage. The Actor developer does not charge any additional fees. This is the default pricing model for many Actors in Apify Store that only charge for platform usage, including a large number of community-built Actors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unsure about this one.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ You can find all your tasks in the [Apify Console](https://console.apify.com/act | |
|
|
||
| ## Create | ||
|
|
||
| To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Create task** button. | ||
| To create a task, open any Actor from [Apify Store](https://console.apify.com/store) or your list of [Actors](https://console.apify.com/actors) in Apify Console. At the top-right section of the page, click the **Save as a new task** button. | ||
|
|
||
|  | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @TC-MO This screenshot deserves a proper refresh. |
||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The numbering looks okay in preview, so maybe there's a fallback to fix it if it's wrong in the code? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, thanks @TC-MO for letting me know it's a feature 🚀.