Skip to content

docs: rewrite Actor-to-Actor integration page#2546

Open
marcel-rbro wants to merge 9 commits into
masterfrom
docs/actor-to-actor-rewrite
Open

docs: rewrite Actor-to-Actor integration page#2546
marcel-rbro wants to merge 9 commits into
masterfrom
docs/actor-to-actor-rewrite

Conversation

@marcel-rbro
Copy link
Copy Markdown
Contributor

Summary

  • Rewrite the Add an integration flow in index.md to match the new integrations dialog in Apify Console; the previous instructions referenced a removed Apify (Connect Actor or Task) affordance
  • Minor tone and style cleanup (active voice, bold for UI elements, removed sales phrasing)
  • Inline <!-- TODO --> markers for items still pending confirmation

Refs #2460

This PR is stacked on top of #2506 (docs/integrations-restructure-tiers). Once that lands, rebase the base to master.

Outstanding TODOs (to resolve before marking ready)

  • Confirm YouTube embed (zExnYbvFoBM) still reflects the current flow
  • Confirm how Actors get listed under Suggested for this Actor
  • Confirm the post-selection screen still uses the trigger + payload + variables layout; recapture screenshots if not
  • Capture a new screenshot for the Add integration dialog (placeholder TODO in source)
  • Confirm "compute units" is still the right billing-unit name in the test-run note
  • Confirm the linked blog tutorial is still current
  • Second pass on integration-ready-actors.md (specific vs generic distinction) and integrating-actors-via-api.md

Test plan

  • pnpm lint passes
  • pnpm build produces no broken-link errors for /integrations/actors
  • Visual check of the rendered page in dev server

🤖 Generated with Claude Code

@apify-service-account
Copy link
Copy Markdown
Contributor

apify-service-account commented May 19, 2026

✅ Preview for this PR (commit da38f68b) is ready at https://pr-2546.preview.docs.apify.com (see action run).

Refresh the Add an integration flow to match the new integrations
dialog in Apify Console. The previous instructions referenced a
removed "Apify (Connect Actor or Task)" affordance. Several TODOs
remain inline for items that still need confirmation.

Refs #2460

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@marcel-rbro marcel-rbro force-pushed the docs/actor-to-actor-rewrite branch from d0d9d70 to 779baca Compare May 19, 2026 11:38
@marcel-rbro marcel-rbro changed the base branch from docs/integrations-restructure-tiers to master May 19, 2026 11:38
@apify-service-account
Copy link
Copy Markdown
Contributor

Python client model regeneration failed. See workflow run.

- Use "trigger" instead of "fire" for consistency with platform
  terminology
- Drop conversational "still" from the test-run note
- Remove emphasis bold from "source" Actor (style guide reserves
  bold for UI elements)
- Replace single "Blog tutorial" link with a "Next steps" section
  pointing at the two sibling pages plus the blog walkthrough

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the t-docs Issues owned by technical writing team. label May 19, 2026
marcel-rbro and others added 2 commits May 19, 2026 15:02
- Rename page title to "Develop integration-ready Actors" so the
  developer audience is explicit; add sidebar_label to match
- Lead the page with a one-line audience statement and an explicit
  framing that any Actor can be a target but designed ones provide
  a better experience
- Add a note linking to Integration Actors in Apify Store for
  inspiration, using the UI term "Integration Actor" for the
  catalog/category and "integration-ready" only as a descriptive
  adjective for Actor design
- Update the cross-link in the Actor-to-Actor page to match the
  new sibling title

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
In index.md:
- Replace ambiguous pronoun "It" with explicit "The UI" on the
  Implementation details paragraph

In integration_ready_actors.md:
- Remove bold used for emphasis (dataset ID, dataset contents,
  "only") - bold reserved for UI elements per style guide
- Drop softening "ideally try to" from the complexity-hiding rule
- Replace first-person plural ("we", "we'd", "we're") with
  imperative/second-person voice throughout the Example section
- Fix "fit to memory" -> "fit in memory"
- Clean up field labels (ID instead of Id, "table or collection"
  instead of "table / collection")
- Refresh the publishing flow to reference the new "Add integration"
  dialog instead of the removed "Connect Actor or task" button
- Fix malformed mailto link (Actor%specific -> Actor%20specific)
- Add inline TODO markers for the stale contact-support listing
  workflow and the outdated specific_vs_generic_integrations.png
  screenshot, mirroring the TODO convention from index.md

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@marcel-rbro marcel-rbro marked this pull request as ready for review May 21, 2026 09:09
@marcel-rbro marcel-rbro requested review from TC-MO and Copilot and removed request for Copilot May 21, 2026 09:09
Comment thread sources/platform/integrations/actors/index.md Outdated
Copy link
Copy Markdown
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

Some changes requested, some related to updated content, some cleanup opportunities.

Comment thread sources/platform/integrations/actors/index.md Outdated
Comment thread sources/platform/integrations/actors/integration_ready_actors.md
Comment thread sources/platform/integrations/actors/integration_ready_actors.md Outdated
Comment thread sources/platform/integrations/actors/integration_ready_actors.md Outdated
Comment thread sources/platform/integrations/actors/index.md Outdated
Comment thread sources/platform/integrations/actors/index.md Outdated
Comment thread sources/platform/integrations/actors/index.md
marcel-rbro and others added 5 commits May 26, 2026 13:00
Address review comments on PR #2546: drop the title question mark,
remove the stale YouTube embed, refresh the setup-screen labels to
match the current Apify Console UI (Start when / Actor input),
tighten the variables wording, and normalize capitalization and
phrasing in the integration-ready Actors example.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Capture the current Apify Console integration setup screen and embed
it under the configuration list so readers can visually anchor the
Start when / Actor input / Available variables sections.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Align the title and lead sentence with the sidebar label so the page name matches how it's referenced across the integrations section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Remove the inline TODOs around "compute units" billing wording and the linked blog post now that both have been confirmed current.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Use "Integrate Actors via API" to match the imperative voice the style guide prefers and align with other action-oriented titles in the section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@marcel-rbro marcel-rbro requested a review from TC-MO May 26, 2026 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants