Skip to content

docs: improve documentation titles and add proxy type links - #2890

Open
jancurn wants to merge 3 commits into
masterfrom
claude/apify-proxy-doc-links-2r9onb
Open

docs: improve documentation titles and add proxy type links#2890
jancurn wants to merge 3 commits into
masterfrom
claude/apify-proxy-doc-links-2r9onb

Conversation

@jancurn

@jancurn jancurn commented Aug 18, 2026

Copy link
Copy Markdown
Member

Improved consistency and clarity across documentation by updating page titles to use gerund forms and adding internal links to related proxy documentation.

Key changes:

  • Updated Actor section titles to use gerund forms ("Developing Actors", "Publishing Actors", "Monetizing Actors", "Running Actors") for consistency with documentation conventions
  • Added internal links to proxy type documentation in the proxy parameters table (datacenter, residential, and Google SERP proxies) to improve navigation and discoverability

https://claude.ai/code/session_01WMamf9TfuBnQiKFwxXaLVM

claude added 2 commits August 18, 2026 12:54
The groups parameter row in the username parameters table only linked the
Unblocker proxy page. Link the datacenter, residential, and Google SERP
proxy pages too, so each group value points at its documentation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WMamf9TfuBnQiKFwxXaLVM
…onetization

Retitle the four Actor section landing pages to Running, Developing,
Publishing, and Monetizing Actors. Sidebar labels stay short and unchanged.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WMamf9TfuBnQiKFwxXaLVM
@apify-service-account

apify-service-account commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

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

Running, Development, Publishing, and Monetization read more naturally in
the sidebar than the imperative Run/Develop/Publish/Monetize.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WMamf9TfuBnQiKFwxXaLVM
@jancurn
jancurn requested a review from TC-MO August 18, 2026 20:43
@TC-MO

TC-MO commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Hey @jancurn thanks for the update to links, valid change. Regarding the gerunds the PR description mentions that this is for consistency with documentation conventions but our convention is actually opposite. As you can see in CONTRIBUTING.md, Quality standards for AI (here & here) & Msoft style guide that we also follow.

@jancurn

jancurn commented Aug 19, 2026

Copy link
Copy Markdown
Member Author

@TC-MO Oh right, I didn't know about the gerunds. Perhaps these rules should be copied in AGENTS.md too, so the agents pick them up?

The reason why I changed it is that the imperative form (Run, Develop, Publish, Monetize) is suitable for landing pages but doesn't feel right for docs:

Screenshot 2026-08-19 at 9 48 06

How about using "Actor running", "Actor development", "Actor publishing", "Actor monetization" instead of gerunds?

@jancurn

jancurn commented Aug 19, 2026

Copy link
Copy Markdown
Member Author

@TC-MO here is another PR to ensure agents respect CONTIBUTING.md - #2893

@TC-MO

TC-MO commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

I'll take a separate look on #2893 to keep this on topic of PR :)

Let's keep imperatives here. One of our goals is more task-based docs and these four sections are exactly that. The Run section is a landing page but also includes what is necessary to run Actors. Publish, Monetize & Develop work in the same way.

On adding Actor to each of those, we are already in Actors section I see little if not none value in that addition. It would only serve to be more visually cluttered.

@jancurn

jancurn commented Aug 19, 2026

Copy link
Copy Markdown
Member Author

Do you have some examples of top docs using the imperatives? I don't recall seeing this anywhere, except for marketing pages. I didn't mean to add "Actor" to menu, but have it in the page title.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants