Skip to content

docs: update publish task naming and add unpublish section - #2855

Merged
jgagne merged 13 commits into
masterfrom
docs/publish-task-update
Aug 18, 2026
Merged

docs: update publish task naming and add unpublish section#2855
jgagne merged 13 commits into
masterfrom
docs/publish-task-update

Conversation

@jgagne

@jgagne jgagne commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Changes

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

SEO

  • Meta description rewritten: removes jargon, states outcome plainly
  • Weak/strong task title table: trimmed from 5 rows to 3, three examples are enough to make the point. Replaced with real example task titles from Google Maps Scraper, now names a specific city for stronger location targeting

Naming (from original PR)

  • "Publication" tab to "Publishing"
  • "Display information" to "Page details"
  • "SERP preview" to "Google preview"
  • "Examples" tab to "Example tasks"

Screenshots to update

Screenshot Status Notes
task-publishing-tab.webp Verify Recaptured from renamed file, confirm UI matches
task-page-details.webp Verify Recaptured from renamed file, confirm UI shows "Page details"
task-unpublish-dialog.webp Missing Needs capture (Unpublish section is new)
actor-examples-tab.webp Verify Tab was renamed to "Example tasks"
task-input-section.webp OK No UI changes
task-dataset-schema.webp OK No UI changes
task-landing-page.webp OK No UI changes

Copy lint pass

  • Parallel user-centered intro: "what it does, what inputs to provide, and what output to expect"
  • "more discoverability means more paid runs" (docs voice, replaces marketing tone)
  • Plain language: "shows up in Google results" (replaces "indexed by search engines")
  • Slug: spells out constraints (lowercase, hyphens, no spaces)
  • "preview updates as you type" (replaces "live preview how fields propagate")
  • Consistent possessive ("your original task")
  • Remove redundant "automatically" and "public" where context implies them
  • Bold all UI element names in prose (Publishing tab, Input section, Dataset schema section)

@apify-service-account

apify-service-account commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@jgagne jgagne changed the title docs: fix publish task naming and add unpublish section docs: update publish task naming and add unpublish section Aug 5, 2026
@jgagne jgagne self-assigned this Aug 5, 2026
- 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.
@jgagne
jgagne force-pushed the docs/publish-task-update branch 2 times, most recently from 55b393b to 0ce96c8 Compare August 5, 2026 21:05
jgagne added 2 commits August 5, 2026 23:08
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
@jgagne
jgagne force-pushed the docs/publish-task-update branch from 0ce96c8 to 2f0165c Compare August 5, 2026 21:09
@jgagne
jgagne force-pushed the docs/publish-task-update branch from 540686a to bf5e6d3 Compare August 5, 2026 21:13
- "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
@jgagne
jgagne force-pushed the docs/publish-task-update branch from 741d4ce to 540e821 Compare August 5, 2026 21:22
@jgagne jgagne added the adhoc Ad-hoc unplanned task added during the sprint. label Aug 6, 2026
jgagne added 4 commits August 6, 2026 15:22
- 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.
@jgagne
jgagne force-pushed the docs/publish-task-update branch from d0ba748 to 8885897 Compare August 6, 2026 14:21
@jgagne
jgagne marked this pull request as ready for review August 10, 2026 12:15
@hanatsai
hanatsai requested review from jbartadev and removed request for martin-sabo-98 August 10, 2026 12:59

@hanatsai hanatsai left a comment

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.

Left few ideas. Thanks a lot! I'll update the image once we have updated copy in the console.

Comment thread sources/platform/actors/publishing/publish-task.mdx Outdated
## 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.

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

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.

linking users directly to the landing page.

I would keep "visitors" since they're still not becoming our user?

@jgagne jgagne Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

jgagne added 2 commits August 10, 2026 18:48
- Public tasks to Published tasks (consistent with rest of page)
- Indexed sentence was moved to Target search traffic section, not removed
@jgagne
jgagne force-pushed the docs/publish-task-update branch from a3397e6 to 2bc49a5 Compare August 10, 2026 17:21
@jgagne
jgagne requested a review from hanatsai August 10, 2026 17:24

@jbartadev jbartadev left a comment

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.

Nice job! Added a couple of suggestions and nits


Unpublishing removes the landing page, but your task and its configuration stay saved. Republish anytime.

![Unpublish confirmation dialog with a Confirm button.](./images/public-tasks/task-unpublish-dialog.webp)

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.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@hanatsai is handling screenshots. With a noted contribution update from Docs on screenshots:

3. Screenshots:

Comment thread sources/platform/actors/publishing/publish-task.mdx Outdated
Comment thread sources/platform/actors/publishing/publish-task.mdx Outdated
Comment thread sources/platform/actors/publishing/publish-task.mdx Outdated
Comment thread sources/platform/actors/publishing/publish-task.mdx Outdated
- 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
@jgagne
jgagne force-pushed the docs/publish-task-update branch from 15eaf62 to 8d056dd Compare August 11, 2026 14:37
@jgagne
jgagne requested a review from jbartadev August 11, 2026 14:38

@hanatsai hanatsai left a comment

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.

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.
@jgagne
jgagne merged commit c26acd2 into master Aug 18, 2026
14 checks passed
@jgagne
jgagne deleted the docs/publish-task-update branch August 18, 2026 12:11
@TC-MO

TC-MO commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

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?

@hanatsai

hanatsai commented Aug 18, 2026

Copy link
Copy Markdown
Member

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.

@TC-MO

TC-MO commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

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?

@TC-MO

TC-MO commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Oh and please also any changes to documentation should be labeled with documentation label. This way it will also show up on our docs kanban instead of getting lost

@jgagne jgagne added the documentation Improvements or additions to documentation. label Aug 18, 2026
@jgagne

jgagne commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

@TC-MO My apologies for not following up sooner. Thank you for your feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. documentation Improvements or additions to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants