Skip to content

docs: Improve PPE docs based on feedback #1936

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
patrikbraborec merged 1 commit into from
Sep 22, 2025
Merged

docs: Improve PPE docs based on feedback #1936

patrikbraborec merged 1 commit into from
Sep 22, 2025

Conversation

@patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Sep 18, 2025

The following changes edit the PPE documentation based on feedback from @metalwarrior665 and also based on Discord discussion.

@apify-service-account
Copy link

apify-service-account commented Sep 18, 2025

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

@TC-MO
Copy link
Contributor

TC-MO commented Sep 18, 2025

That added section kind of feels like it should be within Best practices WDYT?

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Sep 18, 2025 •
edited
Loading

No, we agreed with Lukas that it should be rather outside the Best practices as it is must have, and not the best practice. But the title can be changed, etc.

@TC-MO
Copy link
Contributor

TC-MO commented Sep 18, 2025

Cool that was just first thought, thanks for context I'll do thorough review of language and IA later today

metalwarrior665
metalwarrior665 approved these changes Sep 18, 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.

Don't see any issues, thanks!

@metalwarrior665
Copy link
Member

metalwarrior665 commented Sep 18, 2025

It is not a new section, I just suggested to Patrik to move it before the Best practices section. The rest is just removing the main function wrapper in examples

TC-MO
TC-MO approved these changes Sep 19, 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

@apify-service-account
Copy link

apify-service-account commented Sep 22, 2025

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

@patrikbraborec patrikbraborec merged commit 9651b98 into master Sep 22, 2025
11 checks passed
@patrikbraborec patrikbraborec deleted the docs/ppe-updates branch September 22, 2025 07:58
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

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

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@patrikbraborec @apify-service-account @TC-MO @metalwarrior665