Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
212 changes: 212 additions & 0 deletions docs-vs-console-discrepancies.md
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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Apify.H1] Do not use H1 headings (#). The main title is generated automatically. Please use H2 (##) or lower. Raw Output: {"message": "[Apify.H1] Do not use H1 headings (#). The main title is generated automatically. Please use H2 (##) or lower.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': m'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': m'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 15, "column": 25}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': w'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': w'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 23, "column": 30}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': m'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': m'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 41, "column": 15}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': o'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': o'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 65, "column": 16}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': w'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': w'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 113, "column": 30}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': w'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': w'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 121, "column": 19}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': w'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': w'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 129, "column": 17}}}, "severity": "ERROR"}

**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

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Microsoft.HeadingColons] Capitalize ': o'. Raw Output: {"message": "[Microsoft.HeadingColons] Capitalize ': o'.", "location": {"path": "docs-vs-console-discrepancies.md", "range": {"start": {"line": 139, "column": 22}}}, "severity": "ERROR"}

**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
Expand Up @@ -180,7 +180,7 @@ Actor detail https://console.apify.com/actors/Yk1bieximsduYDydP
Success: Actor was deployed to Apify cloud and built there.
```

The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > Integrations** in Apify Console, we can construct a link which will call the Actor:
The URLs tell us that our Actor's ID is `Yk1bieximsduYDydP`. With this `actorId`, and our `token`, which is retrievable through **Settings > API & Integrations** in Apify Console, we can construct a link which will call the Actor:

```text
https://api.apify.com/v2/acts/Yk1bieximsduYDydP/runs?token=YOUR_TOKEN_HERE
Expand Down
2 changes: 1 addition & 1 deletion sources/academy/platform/getting_started/apify_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ from apify_client import ApifyClient

In the last lesson, we ran the **adding-actor** and retrieved its dataset items. That's exactly what we're going to do now; however, by using the Apify client instead.

Before we can use the client though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**Integrations** page](https://console.apify.com/account?tab=integrations&asrc=developers_portal) on Apify Console:
Before we can use the client though, we must create a new instance of the `ApifyClient` class and pass it our API token from the [**API & Integrations** page](https://console.apify.com/settings/integrations?asrc=developers_portal) on Apify Console:

<Tabs groupId="main">
<TabItem value="Node.js" label="Node.js">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To run, or **call**, an Actor/task, you will need a few things:

- The name or ID of the Actor/task. The name looks like `username~actorName` or `username~taskName`. The ID can be retrieved on the **Settings** page of the Actor/task.

- Your [API token](/platform/integrations), which you can find on the **Integrations** page in [Apify Console](https://console.apify.com/account?tab=integrations) (do not share it with anyone!).
- Your [API token](/platform/integrations), which you can find on the **API & Integrations** page in [Apify Console](https://console.apify.com/settings/integrations) (do not share it with anyone!).

- Possibly an input, which is passed in JSON format as the request's **body**.

Expand Down Expand Up @@ -158,7 +158,7 @@ Here is a Node.js example of calling a task via the API and logging the dataset
import got from 'got';

// Specify your API token
// (find it at https://console.apify.com/account#/integrations)
// (find it at https://console.apify.com/settings/integrations)
const myToken = '<YOUR_APIFY_TOKEN>';

// Start apify/google-search-scraper Actor
Expand Down
2 changes: 1 addition & 1 deletion sources/academy/tutorials/api/using_apify_from_php.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Apify does not have an official PHP client (yet), so we are going to use [guzzle

## Before you start

Make sure you have an Apify account and API token. You will find the token in the [Integrations](https://console.apify.com/account#/integrations) section in Apify Console.
Make sure you have an Apify account and API token. You will find the token in the [API & Integrations](https://console.apify.com/settings/integrations) section in Apify Console.

If you don't already have guzzle installed in your project (or just want to try out the code examples), run `composer require guzzlehttp/guzzle` to install it in the current directory.

Expand Down
2 changes: 1 addition & 1 deletion sources/api/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You must authenticate all API requests presented on this page. You can authentic
Authorization: Bearer YOUR_API_TOKEN
```

You can find your API token in Apify Console under **[Settings > Integrations](https://console.apify.com/settings/integrations)**.
You can find your API token in Apify Console under **[Settings > API & Integrations](https://console.apify.com/settings/integrations)**.

### Verify your account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,4 @@ To run a clean build without using the cache:
1. Go to your Actor page.
1. Select **Source** > **Code**.
1. Expand **Build** options and choose **Clean build**.
>>>>>>> f543b3ec (The third round)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -22,9 +22,9 @@ Log in to [Apify Console](https://console.apify.com), navigate to [**My Actors**

![Create Actor](./images/create-actor.png)

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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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

Expand Down Expand Up @@ -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.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions sources/platform/actors/running/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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**.

![Actor input](./images/apify-input.png)

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/running/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

![Create a new Apify task](./images/tasks/tasks-create-task.png)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TC-MO This screenshot deserves a proper refresh.


Expand Down
4 changes: 2 additions & 2 deletions sources/platform/collaboration/general-resource-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Some resources, like storages, Actor runs or Actor builds, can be shared simply

Thanks to the hard-to-guess, unique IDs, it’s also secure enough for most use cases. However, it doesn't offer features like access revocation and in some cases, you may want to have more direct control over data access and require users to have explicit permissions to your resources.

**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Security & Privacy**. The two following options are supported:
**General resource access** is an account setting that defines the default access policy at the account level. You can find General resource access in Apify Console under **Settings → Login & Privacy** (or **Settings → Security & Privacy** for organization accounts). The two following options are supported:

- **Anyone with ID can read (default)**: Selected resources can be accessed using just their unique resource ID. This means if you share the resource ID with someone, they would be able to view it without providing an API token or viewing the resource by visiting the Console URL.
- **Restricted**: With this setting, only signed-in users with an explicit access to the resources can access them. To access restricted resources via API, a valid token needs to be provided.
Expand Down Expand Up @@ -79,7 +79,7 @@ When you share an Actor with a collaborator, you can choose to share read-only a

If you’re using a public Actor from Apify Store, you can choose to automatically share your runs of that Actor with its creator. This helps developers monitor usage and troubleshoot issues more effectively.

- This setting is opt-in and can be enabled under **Account Settings → Privacy**
- This setting is opt-in and can be enabled under **Settings → Login & Privacy** in the **Share run data with developers** section
- When enabled, your runs of public Actors are automatically visible to the Actor’s creator
- Shared runs include logs, input, and output storages (dataset, key-value store, request queue)

Expand Down
Loading
Loading