Skip to content

docs: PPE docs improvements #1948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 28 commits into from
Oct 1, 2025
Merged

docs: PPE docs improvements #1948

merged 28 commits into from
Oct 1, 2025

Conversation

patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Sep 24, 2025 •
edited
Loading

The PR improves and fixes several PPE/PPR docs related things:

Please take a look. Thanks!

TODOs:

  • Fix all the comments
  • Add updates about changing monetization
    • I will create a follow up PR

Note

Adds support to update an Actor’s tagged builds via API and substantially updates PPE/PPR monetization docs with clearer examples, guidance, and cross-links.

  • API:
    • Actors: Add taggedBuilds to UpdateActorRequest schema to manage tag→build mappings (latest, beta, etc.).
    • Actor runs charge endpoint: Enhance description with link to PPE docs.
  • Docs:
    • Monetization:
      • Major rewrite of PPE and PPR pages: clearer explanations, PPE vs PPR section, spending-limit guidance, idempotency notes, and best practices.
      • New, simpler examples and pricing breakdowns using tables; added “usage-indexed” PPE example.
      • Expanded synthetic start event (apify-actor-start) guidance and recommendations.
    • Academy/Store basics: Add info callouts and links to PPE/PPR docs; tighten copy.
    • Runs & builds: Note that build tags can be reassigned via Actor update API.

Written by Cursor Bugbot for commit 2accfa7. This will update automatically on new commits. Configure here.

@apify-service-account
Copy link

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

@patrikbraborec patrikbraborec changed the title Docs/ppe docs improvements 3 docs: PPE docs improvements Sep 24, 2025
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@patrikbraborec patrikbraborec mentioned this pull request Sep 24, 2025
Closed
@github-actions github-actions bot added the t-c&c Team covering store and finance matters. label Sep 24, 2025
@apify-service-account
Copy link

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

@patrikbraborec
Copy link
Contributor Author

Hi guys (@TC-MO , @mnmkng , @jirispilka , @metalwarrior665). I would appreciate your "last" review before merge so we can merge it. Thanks!

mnmkng
mnmkng approved these changes Sep 29, 2025
View reviewed changes
Copy link
Member

@mnmkng mnmkng left a comment

Choose a reason for hiding this comment

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

I trust you 😄

metalwarrior665
metalwarrior665 approved these changes Sep 30, 2025
View reviewed changes
Copy link
Member

@metalwarrior665 metalwarrior665 left a comment

Choose a reason for hiding this comment

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

Looks good

jirispilka
jirispilka reviewed Sep 30, 2025
View reviewed changes
Copy link
Contributor

@jirispilka jirispilka left a comment •
edited
Loading

Choose a reason for hiding this comment

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

One more nit: I think it would be nice to use round numbers in the computations and totals.
Sorry, I missed that earlier.

If you tweak the numbers a bit, you can avoid things like $20.05 with two decimal places. This just adds noise.

Perhaps, the intention was to highlight that we automatically round up numbers (which I don’t think we do),

For example, in the last row you have:
1,000 × 0.002 + 5 × 0.001 + 200 × 0.005 = 2 + 0.005 + 1 = 3.01 (not 3.005).

Would something like this work? Note: I've swapped price for post and profile.

image

Otherwise, good for me 💪🏻

TC-MO
TC-MO requested changes Sep 30, 2025
View reviewed changes
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@patrikbraborec patrikbraborec added t-dx Issues owned by the DX team. t-docs Issues owned by technical writing team. and removed t-c&c Team covering store and finance matters. labels Oct 1, 2025
@patrikbraborec patrikbraborec mentioned this pull request Oct 1, 2025
Closed
Pijukatel and others added 4 commits October 1, 2025 14:50
@Pijukatel @patrikbraborec
docs: Add signature query parameter to docs of relevant endpoints (#1955
8e25c8f 
)

### Description:
Update docs with signature query parameter for the following endpoints:
- /key-value-store-record-get
- /key-value-store-keys-get
- /dataset-items-get


### Issues:

Closed: #1954
@renovate @patrikbraborec
chore(deps): update dependency typescript to v5.9.3
39be029
@patrikbraborec
docs: Improve Academy text regarding to Rental, PPR and PPE (#1947)
148ca1a
@patrikbraborec
docs: Rebase and PR comments
6cf2de2
@apify-service-account
Copy link

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

@jirispilka
Copy link
Contributor

Thank you, the pricing looks better

@jirispilka jirispilka self-requested a review October 1, 2025 13:01
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

TC-MO
TC-MO approved these changes Oct 1, 2025
View reviewed changes
Copy link
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.

LGTM after changes, thank you!

@patrikbraborec patrikbraborec merged commit 6dcf4e5 into master Oct 1, 2025
9 checks passed
@patrikbraborec patrikbraborec deleted the docs/ppe-docs-improvements-3 branch October 1, 2025 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@metalwarrior665 metalwarrior665 metalwarrior665 approved these changes

@cursor cursor[bot] cursor[bot] left review comments

@jirispilka jirispilka jirispilka approved these changes

@mnmkng mnmkng mnmkng approved these changes

@TC-MO TC-MO TC-MO approved these changes

@mhamas mhamas Awaiting requested review from mhamas

Assignees

@patrikbraborec patrikbraborec

Labels
t-docs Issues owned by technical writing team. t-dx Issues owned by the DX team.
Projects
None yet
Milestone
124th sprint - Cash & Community team
Development

Successfully merging this pull request may close these issues.
9 participants
@patrikbraborec @apify-service-account @jirispilka @mnmkng @metalwarrior665 @TC-MO @lewis-wow @Copilot @Pijukatel