Skip to content

docs: fill Standby page gaps and cross-link related pages - #2944

Draft
TC-MO wants to merge 7 commits into
masterfrom
docs/standby-url-semantics
Draft

docs: fill Standby page gaps and cross-link related pages#2944
TC-MO wants to merge 7 commits into
masterfrom
docs/standby-url-semantics

Conversation

@TC-MO

@TC-MO TC-MO commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

The Standby developer page was missing the Standby URL contract (stable across runs, unlike the per-run web server URL) and never pointed readers to authentication, scaling, the web server schema, or actor.json, all of which are documented elsewhere; the web server schema page had a single inbound link repo-wide. This adds the URL semantics to the env vars reference and the Standby page, and cross-links the Standby, container web server, Actor definition, and actor.json pages so each hands readers to the right reference.

@TC-MO
TC-MO requested a review from raethlo September 2, 2026 15:17
@TC-MO TC-MO self-assigned this Sep 2, 2026
@TC-MO TC-MO added documentation Improvements or additions to documentation. adhoc Ad-hoc unplanned task added during the sprint. t-docs Issues owned by technical writing team. labels Sep 2, 2026
@apify-service-account

apify-service-account commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

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

@TC-MO TC-MO changed the title docs: standby url semantics docs: fill Standby page gaps and cross-link related pages Sep 2, 2026

@raethlo raethlo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Small nits, otherwise LGMT

Comment on lines +186 to +188
```text
https://jane-doe--my-actor.apify.actor
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Alternatively you can also reference https://{actorId}.apify.actor

https://jane-doe--my-actor.apify.actor
```

Unlike the [container web server](./container_web_server.md) URL, which changes with every run, the Standby URL stays the same for all runs of the Actor. You can share it publicly or hardcode it in applications that call the Actor: copy it from the **Standby** tab on the Actor's detail page rather than building it from the username and Actor name, because some Actors use a different hostname format.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Unlike the [container web server](./container_web_server.md) URL, which changes with every run, the Standby URL stays the same for all runs of the Actor. You can share it publicly or hardcode it in applications that call the Actor: copy it from the **Standby** tab on the Actor's detail page rather than building it from the username and Actor name, because some Actors use a different hostname format.
Unlike the [container web server](./container_web_server.md) URL, which changes with every run, the Standby URL stays the same for all runs of the Actor. You can share it publicly or hardcode it in applications that call the Actor: copy it from the **Endpoints** tab on the Actor's detail page rather than building it from the username and Actor name, because some Actors use a different hostname format.

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. t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants