Skip to content

Conversation

patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Sep 10, 2025

The docs for synthetic start event.

Related to the PR: https://github.com/apify/apify-core/pull/22673.

@apify-service-account
Copy link

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

Copy link
Contributor

@mhamas mhamas left a comment

Choose a reason for hiding this comment

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

In general looks good, I added a couple of comments. @mnmkng also please have a look, if you want to add any story-telling to this, and motivate better why they should use this.

@patrikbraborec other things I think that are worth mentioning

  • you are more attractive to users that need to use your Actor in more API like way (shorter runs)
  • and this is especially important for agentic users in the boom of AI economy
  • and also important to large users, for which the costs of high actors starts are prohibitive and they wouldn't use your actor at all if actor start is too high

This being said, I suggest let's tweak what we can, and we can always polish it further after feeback from @mnmkng , I don't want to condition the release on perfect wording here. Hence, approving.

patrikbraborec and others added 2 commits September 10, 2025 18:12
Co-authored-by: Matej Hamas <matej.hamas@apify.com>
Co-authored-by: Matej Hamas <matej.hamas@apify.com>
@apify-service-account
Copy link

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

1 similar comment
@apify-service-account
Copy link

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

Copy link
Contributor

@souravjain540 souravjain540 left a comment

Choose a reason for hiding this comment

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

I miss the part where we start pushing existing developers to replace their existing events that act as actor-start with this one.

patrikbraborec and others added 2 commits September 11, 2025 12:50
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@apify-service-account
Copy link

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

1 similar comment
@apify-service-account
Copy link

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

@patrikbraborec
Copy link
Contributor Author

Thanks @souravjain540! I added a new section describing this situation.

@apify-service-account
Copy link

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

@mnmkng
Copy link
Member

mnmkng commented Sep 11, 2025

I wrote those docs some time ago, they don't seem to be included or considered. We don't have to block the release, but it would be nice to extend the guidance in a follow up PR.

I know that the general way of writing docs is dry and straight to the point. But that's when you're writing developer docs for developers. This is monetization docs for developers. And since the vast majority of them knows nearly nothing about monetization, we have to be much more supportive IMO. We can't simply tell them "this is how you do it", but we also need to tell them the "why".

@TC-MO
Copy link
Contributor

TC-MO commented Sep 12, 2025

@mnmkng the docs you've linked could maybe fit in with Actorization playbook within Academy? There is a whole section there about How Actor monetization work?. There we try to be a little lighter on the style of writing and be more about why & how instead of traditional dry docs?

@patrikbraborec
Copy link
Contributor Author

@mhamas, @mnmkng - thanks for the feedback, on the other hand I am little bit confused. Are you talking about this PR, or generally the updated PPE docs?

The motivation for the first update of the PPE docs was mainly to add more code examples, best practices for developers, and also separate the Rental, PPR and PPE so we can add disclaimer(s) to the Rental docs.

I think that what are you suggesting (explain why, etc.) is 100% true, and I added it to the document describing additional changes to the PPE docs. Feel free to check the docs. It will be just important to clear out, where this "why" guidelines should be as @TC-MO mentioned above.

@mnmkng
Copy link
Member

mnmkng commented Sep 12, 2025

Personally, I don't care where it lives. I just want the devs to have it available and easy to find / hard to miss. 👍🏻

@mnmkng
Copy link
Member

mnmkng commented Sep 12, 2025

But maybe to make sure it's super clear, the document is called PPE guide, but it really isn't. It's just a a guide for the new actor start. I thought people would extend it with other guides, but they ended up living elsewhere.

So when I'm referencing it in this PR, I mean the specific actor start section that's in there.

@mhamas
Copy link
Contributor

mhamas commented Sep 17, 2025

IMHO, let's get this out and then improve it with the next PR.

@patrikbraborec
Copy link
Contributor Author

I also propose to merge it. I added the improvements to follow ups: #1914

@patrikbraborec patrikbraborec merged commit e369100 into master Sep 19, 2025
10 checks passed
@patrikbraborec patrikbraborec deleted the docs/ppe-docs-improvements-2 branch September 19, 2025 11:29
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.

7 participants