feat: Fixing docs vs actual product disprepancies#2345
Open
feat: Fixing docs vs actual product disprepancies#2345
Conversation
github-actions
bot
added
the
t-management
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Apify documentation to match the current Apify Console UI by correcting outdated Console URLs, tab/button names, and related wording across Platform, API, and Academy docs. It also adds an audit note documenting the identified discrepancies.
Changes:
- Replaced legacy
console.apify.com/account...links with the current Settings routes (notably/settings/integrationsand/settings/organizations) across many docs. - Updated Console UI wording to match current labels (for example API & Integrations, Dashboard, and auth button labels).
- Added an audit markdown file and expanded Store pricing docs to include Pay per usage.
Reviewed changes
Copilot reviewed 42 out of 42 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sources/platform/storage/usage.md | Updates API token location link/text to API & Integrations. |
| sources/platform/storage/request_queue.md | Updates API token location link/text to API & Integrations. |
| sources/platform/storage/key_value_store.md | Updates API token location link/text to API & Integrations. |
| sources/platform/storage/dataset.md | Updates API token location link/text to API & Integrations. |
| sources/platform/schedules.md | Updates token/user ID links to current Settings URLs. |
| sources/platform/monitoring/index.md | Updates integrations settings link to current Settings URL. |
| sources/platform/integrations/workflows-and-notifications/workato.md | Updates Settings navigation text/link to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/telegram.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/slack.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/n8n/website-content-crawler.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/youtube.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/tiktok.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/search.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/maps.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/llm.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/instagram.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/facebook.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/amazon.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/make/ai-crawling.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/workflows-and-notifications/gumloop/index.md | Updates Settings navigation text and image alt text to API & Integrations. |
| sources/platform/integrations/programming/api.md | Renames “Integrations” references to API & Integrations for token management. |
| sources/platform/integrations/data-storage/keboola.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/data-storage/airbyte.md | Updates Settings navigation text to API & Integrations. |
| sources/platform/integrations/ai/openai_assistants.md | Updates token link to current Settings integrations URL. |
| sources/platform/integrations/ai/openai_agents.md | Updates token link/text to API & Integrations. |
| sources/platform/integrations/ai/mcp.md | Updates token link/text to API & Integrations. |
| sources/platform/integrations/ai/langchain.md | Updates token link to current Settings integrations URL. |
| sources/platform/integrations/ai/haystack.md | Updates token link to current Settings integrations URL. |
| sources/platform/integrations/ai/chatgpt.md | Updates token link/text to API & Integrations. |
| sources/platform/integrations/ai/agno.md | Updates token link to current Settings integrations URL. |
| sources/platform/console/settings.md | Restructures Settings docs to match current tabs (Login & Privacy, API & Integrations, Referrals). |
| sources/platform/console/index.md | Updates Console onboarding + renames homepage references to Dashboard; updates nav table. |
| sources/platform/console/billing.md | Renames Subscriptions tab reference to Subscription. |
| sources/platform/collaboration/organization_account/index.md | Updates Organizations links to /settings/organizations. |
| sources/platform/collaboration/organization_account/how_to_use.md | Updates Organizations link to /settings/organizations and token tab naming. |
| sources/platform/actors/running/store.md | Documents Pay per usage pricing model and adds a dedicated section. |
| sources/api/getting-started.mdx | Updates token location text to API & Integrations. |
| sources/academy/tutorials/api/using_apify_from_php.md | Updates token location link/text to API & Integrations. |
| sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md | Updates token location link/text and inline comment URL. |
| sources/academy/platform/getting_started/apify_client.md | Updates token location link/text to API & Integrations. |
| sources/academy/platform/expert_scraping_with_apify/solutions/integrating_webhooks.md | Updates token location text to API & Integrations. |
| docs-vs-console-discrepancies.md | Adds a written audit record of docs vs Console UI discrepancies. |
| | Tab name | Description | | ||
| | :--- | :--- | | ||
| | [Apify Store](/platform/console/store) | Search for Actors that suit your web-scraping needs. | | ||
| | Dashboard | Overview of your account with recently viewed Actors, suggestions, and recent runs. | |
There was a problem hiding this comment.
In the sidebar table, the new "Dashboard" row is the only entry without a link. To keep the table consistent and navigable, consider linking it to the Console dashboard docs page (likely this page’s slug, e.g. /platform/console).
Suggested change
| | Dashboard | Overview of your account with recently viewed Actors, suggestions, and recent runs. | | |
| | [Dashboard](/platform/console) | Overview of your account with recently viewed Actors, suggestions, and recent runs. | |
| The [Apify API](/api/v2/storage-request-queues) allows you programmatic access to your request queues using [HTTP requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). | ||
|
|
||
| If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations) page of your Apify account. | ||
| If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [API & Integrations](https://console.apify.com/settings/integrations) page of your Apify account. |
There was a problem hiding this comment.
This sentence is in the Request queue doc but says "accessing your datasets". Update the wording to refer to request queues (and ideally use a request-queue-specific ID/name format) so the authentication guidance matches the resource being documented.
| The [Apify API](/api/v2/storage-key-value-stores) enables you programmatic access to your key-value stores using [HTTP requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). | ||
|
|
||
| If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [Integrations](https://console.apify.com/account#/integrations) tab of **Settings** page of your Apify account. | ||
| If you are accessing your datasets using the `username~store-name` [store ID format](./index.md), you will need to use your secret API token. You can find the token (and your user ID) on the [API & Integrations](https://console.apify.com/settings/integrations) tab of **Settings** page of your Apify account. |
There was a problem hiding this comment.
This Key-value store doc line says "accessing your datasets" even though the section is about key-value stores. Adjust the wording to "key-value stores" so the authentication instructions are not misleading.
|
|
||
| ### 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. |
There was a problem hiding this comment.
The new "Pay per usage" section says this is the default pricing model "especially private Actors". Private Actors are not in Apify Store, so this can confuse readers on a page specifically about Store pricing. Consider removing the private-Actors reference or rephrasing to focus on Store Actors that only charge platform usage.
Suggested change
| 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. |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
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.
I confronted the docs against the local Console. This fixes a wild mix of outdated URLs, outdated texts, buttons, and other.