docs: update publish task naming and add unpublish section - #2855
Conversation
|
🗑️ Preview for this PR was deleted. |
- Fixes the SEO title field label mismatch with its own required-field error. - Renames the Publication tab to Publishing. - Renames the Display information section to Page details. - Renames SERP preview to Google preview. - Fixes Page preview and Google preview from Title Case to sentence case. - Renames the Examples tab to Example tasks. - Removes redundant phrasing across the page. - Adds a section on unpublishing a task. - Placeholder: unpublish screenshot pending capture. - Placeholder: Publish status filter pending shipping.
55b393b to
0ce96c8
Compare
Copy fixes: - "what it does, what inputs to provide, and what output to expect" (parallel and user-centered, replaces "it produces") - "more discoverability means more paid runs" (docs voice, not marketing) - Slug: spell out constraints (lowercase, hyphens, no spaces) - "preview updates as you type" (replaces "live preview how fields propagate") - "your original task" (consistent possessive) - Remove "automatically" from AI generation line (redundant with AI icon) - Unpublish: state outcome of confirm action New feature documentation: - Use case field (required, for Store categorization) - AI icon for generating SEO title and description - Publishing tab progress guide - Publish confirmation (privacy reassurance) - After publishing: share dialog and View landing page button - Privacy note in "After a user tries your task" - Prerequisites: blocking state when schemas are missing
- Remove "public use-case" (redundant, not a search term)
- Remove implementation detail ("by completing the... sections")
- Add benefit: discoverable on Google and by AI agents
- Plain language pass on AI discovery section
0ce96c8 to
2f0165c
Compare
540686a to
bf5e6d3
Compare
- "task-publication-tab" to "task-publishing-tab" (matches renamed UI) - "task-display-information" to "task-page-details" (matches renamed section) - Alt text now describes what the screenshot shows, not just labels it
741d4ce to
540e821
Compare
- Replaces two rows with real example task titles currently live on Google Maps Scraper, verified on apify.com. - Keeps the "Generic task/Specific task" table headers as-is. - Tightens the Amazon and Yahoo Finance strong titles to a single focus each, matching the section's own stated principle. - Fixes the intro line to name all three Actors shown in the table. - Updates a leftover "dentist" reference and the URL structure example to match the new table.
- Changes "Analyze local business competitors with AI" to "Analyze San Francisco business competitors with AI", naming an actual location instead of the placeholder word "local". - Updates the matching sentence below the table to reference the new phrase. - Simplifies the sentence after the table to "Each task focuses on a specific industry, location, or workflow", removing a redundant modifier on "task". - Note: the San Francisco example is no longer verbatim from the live Google Maps Scraper Examples tab, it's a modified version. The other two rows in this table remain our own examples, not live ones.
d0ba748 to
8885897
Compare
hanatsai
left a comment
There was a problem hiding this comment.
Left few ideas. Thanks a lot! I'll update the image once we have updated copy in the console.
| ## Task landing page | ||
|
|
||
| Each published task gets its own standalone landing page on the [Apify website](https://apify.com). This page is publicly accessible, indexed by search engines, and readable by AI agents. Published tasks also appear in the **Examples** tab of the Actor's detail page, linking visitors directly to the landing page. | ||
| Each published task gets its own standalone landing page on the [Apify website](https://apify.com). Published tasks also appear in the **Example tasks** tab of the Actor's detail page, linking users directly to the landing page. |
There was a problem hiding this comment.
This page is publicly accessible, indexed by search engines, and readable by AI agents.
This sentence might be important for the publishers, shall we keep it?
There was a problem hiding this comment.
linking users directly to the landing page.
I would keep "visitors" since they're still not becoming our user?
There was a problem hiding this comment.
Restored with a rewrite.
Good instinct, but I checked, "visitors" doesn't appear anywhere in the platform docs (zero hits across /platform/). The convention is "users" for everyone, including people who haven't signed up. Kept it for consistency with the rest of the docs.
- Public tasks to Published tasks (consistent with rest of page) - Indexed sentence was moved to Target search traffic section, not removed
…s into docs/publish-task-update
a3397e6 to
2bc49a5
Compare
jbartadev
left a comment
There was a problem hiding this comment.
Nice job! Added a couple of suggestions and nits
|
|
||
| Unpublishing removes the landing page, but your task and its configuration stay saved. Republish anytime. | ||
|
|
||
|  |
There was a problem hiding this comment.
Important: task-unpublish-dialog.webp is missing. It isn't in the branch with other changes -images/public-tasks/ only has actor-examples-tab, task-dataset-schema, task-input-section, task-landing-page, task-page-details, task-publishing-tab.
- Meta description: "Google" to "search engines" (broader, 140 chars) - "After publishing" to "Publish confirmation" (dialog appears before, not after) - Clarify dialog timing: "When you select Publish task, a confirmation..." - AI icon: add "next to each field" for discoverability
15eaf62 to
8d056dd
Compare
hanatsai
left a comment
There was a problem hiding this comment.
Thanks Justin! Let's merge it. I'll adjust the screenshot later 🙏 (if we have text placeholder for the image, let's make sure we remove it before the merge)
task-unpublish-dialog.webp does not exist yet. Replaced broken image reference with HTML comment to prevent broken image in production.
|
Can I get a bit of context on that? Those are some pretty significant documentation changes yet not TW was pulled for any review or consulted at all? |
|
Hi Michal @TC-MO sorry for not align with you about the changes. It's related to this feedback and we did a copy updates for the published tasks. It'll soon released with this PR. It's also nice to synchronize the copy in the publish task documentation. That's why we did the copy review and update with Justin here. |
|
Hey @hanatsai thanks for the context. It's all good we encourage teams pitching in to docs :) But important for us is that @apify/docs team is always pulled as reviewer for changes to make sure that changes are inline with our style guide etc. So in the future please either use @apify/docs or just pull your groups assigned TW as reviewer. @marcel-rbro can you take a look here make sure everything is fine? |
|
Oh and please also any changes to documentation should be labeled with |
|
@TC-MO My apologies for not following up sooner. Thank you for your feedback. |
Changes
New feature documentation
SEO
Naming (from original PR)
Screenshots to update
task-publishing-tab.webptask-page-details.webptask-unpublish-dialog.webpactor-examples-tab.webptask-input-section.webptask-dataset-schema.webptask-landing-page.webpCopy lint pass