docs: Improvements of PPE docs #1875

patrikbraborec · 2025-09-04T07:11:11Z

The following PR improves PPE documentation:

Breaks the monetize page into multiple pages in order to make it simpler for users to read
Adds code examples and best practices for PPR and PPE

https://github.com/apify/apify-core/pull/22987

TODOs:

Apify Python SDK does not have get_charged_event_count method similar to Apify JavaScript SDK (getChargedEventCount). I am discussing with the tooling team about the correct implementation in Actor.
PR adding the get_charged_event_count method to the Python SDK.
Add synthetic event (docs: Add synthetic event docs #1835)
Add info based on docs: Improvements of PPE docs #1875 (comment)

cursor

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, please have a team admin upgrade your team to Bugbot Pro by visiting the Cursor dashboard. Your first 14 days will be free!

Comment @cursor review or bugbot run to trigger another review on this PR

sources/platform/actors/publishing/monetize/pay_per_event.mdx

apify-service-account · 2025-09-04T07:28:04Z

Preview for this PR was built for commit 2c27dd46 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-04T07:50:27Z

Preview for this PR was built for commit 600359eb and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-04T08:12:05Z

Preview for this PR was built for commit 832beb5b and is ready at https://pr-1875.preview.docs.apify.com!

metalwarrior665

I think this is a great step forward. I added a few comments to resolve.

sources/platform/actors/publishing/monetize/pay_per_event.mdx

sources/platform/actors/publishing/monetize/pay_per_result.mdx

sources/platform/actors/publishing/monetize/pay_per_event.mdx

apify-service-account · 2025-09-05T13:34:30Z

Preview for this PR was built for commit 951b444 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-05T13:37:25Z

Preview for this PR was built for commit 65ce975 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-05T13:46:07Z

Preview for this PR was built for commit 707fc4f and is ready at https://pr-1875.preview.docs.apify.com!

mhamas

In general looks good, thanks! I've left a couple of comments, please, have a look. Thanks!

sources/platform/actors/publishing/monetize/index.mdx

sources/platform/actors/publishing/monetize/pay_per_result.mdx

sources/platform/actors/publishing/monetize/pricing_and_costs.mdx

sources/platform/actors/publishing/monetize/rental.mdx

sources/platform/actors/publishing/monetize/pay_per_event.mdx

sources/platform/actors/publishing/monetize/pay_per_result.mdx

sources/platform/actors/publishing/monetize/index.mdx

sources/platform/actors/publishing/monetize/pay_per_event.mdx

sources/platform/actors/publishing/monetize/pricing_and_costs.mdx

sources/platform/actors/publishing/monetize/rental.mdx

apify-service-account · 2025-09-08T13:21:08Z

Preview for this PR was built for commit d5323417 and is ready at https://pr-1875.preview.docs.apify.com!

Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-09-08T13:36:40Z

Preview for this PR was built for commit ed58c593 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-08T13:42:18Z

Preview for this PR was built for commit ea3cc398 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-08T14:55:34Z

Preview for this PR was built for commit 2f7a9c69 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-09T13:51:10Z

Preview for this PR was built for commit 347a6051 and is ready at https://pr-1875.preview.docs.apify.com!

patrikbraborec · 2025-09-09T14:14:17Z

@metalwarrior665, @mhamas, @TC-MO - I propose to merge it, and solve the open discussion later (I can create follow up issues).

What do you think?

metalwarrior665

Just a few small comments but I agree that we can relase it and iterate on the pending comments later.

sources/platform/actors/publishing/monetize/pay_per_event.mdx

sources/platform/actors/publishing/monetize/pay_per_result.mdx

sources/platform/actors/publishing/monetize/index.mdx

sources/platform/actors/publishing/monetize/pay_per_result.mdx

sources/platform/actors/publishing/monetize/pay_per_event.mdx

apify-service-account · 2025-09-10T13:43:11Z

Preview for this PR was built for commit b76afbc3 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-10T13:46:32Z

Preview for this PR was built for commit 347a6051 and is ready at https://pr-1875.preview.docs.apify.com!

Co-authored-by: Michał Olender <[email protected]>

apify-service-account · 2025-09-10T13:50:26Z

Preview for this PR was built for commit bcde3193 and is ready at https://pr-1875.preview.docs.apify.com!

apify-service-account · 2025-09-10T13:54:06Z

Preview for this PR was built for commit 99ff1181 and is ready at https://pr-1875.preview.docs.apify.com!

TC-MO

LGTM, great work, and not an easy task!

patrikbraborec requested a review from TC-MO as a code owner September 4, 2025 07:11

patrikbraborec marked this pull request as draft September 4, 2025 07:14

cursor bot reviewed Sep 4, 2025

View reviewed changes

sources/platform/actors/publishing/monetize/pay_per_event.mdx Outdated Show resolved Hide resolved

metalwarrior665 requested changes Sep 4, 2025

View reviewed changes

patrikbraborec added 9 commits September 5, 2025 14:44

docs: PPE refactor - first draft

a5f8fda

docs: PPE pricing improvements

bf43145

Fix lint errors

7145a17

Fix lint errors

4500938

Fix build errors

196e832

Add correct python method

7fd6f77

Fix stylistic issue

5280723

docs: Pay per result PR comments fixes

3508d8b

docs: Fix PR comments in PPR

951b444

patrikbraborec force-pushed the docs/ppe-docs-improvements branch from 832beb5 to 951b444 Compare September 5, 2025 13:30

docs: Fix event name

65ce975

docs: Edit PPR python example

707fc4f

mhamas requested changes Sep 5, 2025

View reviewed changes

TC-MO reviewed Sep 5, 2025

View reviewed changes

docs: First round of reviews

d532341

Apply suggestions from code review

ed58c59

Co-authored-by: Michał Olender <[email protected]>

docs: Fix lint errors

ea3cc39

patrikbraborec added 2 commits September 8, 2025 15:47

docs: PR review comments

4870c1b

docs: Fix another PR comments

2f7a9c6

patrikbraborec marked this pull request as ready for review September 9, 2025 13:21

docs: Fix PR comments

347a605

metalwarrior665 approved these changes Sep 10, 2025

View reviewed changes

sources/platform/actors/publishing/monetize/pay_per_event.mdx Outdated Show resolved Hide resolved

sources/platform/actors/publishing/monetize/pay_per_event.mdx Show resolved Hide resolved

sources/platform/actors/publishing/monetize/pay_per_result.mdx Show resolved Hide resolved

TC-MO requested changes Sep 10, 2025

View reviewed changes

patrikbraborec mentioned this pull request Sep 10, 2025

Consider to edit/remove bold descriptions (redundant with frontMatter) #1913

Open

patrikbraborec requested a review from mnmkng as a code owner September 10, 2025 13:39

patrikbraborec mentioned this pull request Sep 10, 2025

Follow-ups from PPE docs refactor #1914

Closed

patrikbraborec force-pushed the docs/ppe-docs-improvements branch from b76afbc to 347a605 Compare September 10, 2025 13:41

docs: Fix PR comments

bcde319

patrikbraborec removed the request for review from mnmkng September 10, 2025 13:44

patrikbraborec and others added 3 commits September 10, 2025 15:47

Apply suggestions from code review

4decc54

Co-authored-by: Michał Olender <[email protected]>

Apply suggestions from code review

3096c2f

Co-authored-by: Michał Olender <[email protected]>

Apply suggestions from code review

99ff118

Co-authored-by: Michał Olender <[email protected]>

TC-MO approved these changes Sep 10, 2025

View reviewed changes

mhamas approved these changes Sep 10, 2025

View reviewed changes

patrikbraborec merged commit 56bf9c2 into master Sep 10, 2025
9 checks passed

patrikbraborec deleted the docs/ppe-docs-improvements branch September 10, 2025 14:26

docs: Improvements of PPE docs #1875

docs: Improvements of PPE docs #1875

Uh oh!

Conversation

patrikbraborec commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

This PR is being reviewed by Cursor Bugbot

Uh oh!

Uh oh!

apify-service-account commented Sep 4, 2025

Uh oh!

apify-service-account commented Sep 4, 2025

Uh oh!

apify-service-account commented Sep 4, 2025

Uh oh!

metalwarrior665 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Sep 5, 2025

Uh oh!

apify-service-account commented Sep 5, 2025

Uh oh!

apify-service-account commented Sep 5, 2025

Uh oh!

mhamas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Sep 8, 2025

Uh oh!

apify-service-account commented Sep 8, 2025

Uh oh!

apify-service-account commented Sep 8, 2025

Uh oh!

apify-service-account commented Sep 8, 2025

Uh oh!

apify-service-account commented Sep 9, 2025

Uh oh!

patrikbraborec commented Sep 9, 2025

Uh oh!

metalwarrior665 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patrikbraborec commented Sep 4, 2025 •

edited

Loading