docs: security section - #2888
Open
TC-MO wants to merge 15 commits into
Open
Conversation
TC-MO
added
documentation
Contributor
|
✅ Preview for this PR (commit |
filakovsky
approved these changes
Aug 24, 2026
filakovsky
left a comment
filakovsky
left a comment
Contributor
There was a problem hiding this comment.
I like it, thanks @TC-MO !
Split the standalone /security page into a multi-page section: an overview hub at /security and the full vulnerability disclosure policy at /security/vulnerability-disclosure. Add the security sidebar entry. Preserve the /security#vulnerability-disclosure-policy anchor on the hub so existing external links still resolve.
Add the shared responsibility model at /security/shared-responsibility and link it from the security hub. Keep the security whitepaper as an external PDF asset (linked, not duplicated in docs), matching the Actor whitepaper precedent and how peers publish security whitepapers.
…page Address review-docs findings: description lengths in range, drop article before Apify Store, spell out Apify Proxy in the table, active voice, and a missing-article grammar fix. Light prose tightening on the shared responsibility page (independently verified as lossless).
Updated wording for clarity on Actor runtime isolation.
Add a technical overview of how the platform is built: control and execution planes, the anatomy of an Actor run, workload isolation, storage, and availability. Scope it to mechanism and link out to the security pages for encryption, compliance, and data residency rather than duplicating them. Link it from the Get started overview.
…fixes Replace relative .md links and one hardcoded docs.apify.com URL with absolute slugs, so internal links follow a single style that also works for the SDK, CLI, and client docs served from other repos. Apply the first standards review of the architecture page and security hub: drop first-person 'our' from the hub, add missing image alt text, fix list parallelism, replace unmeasured claims and passive voice where the actor is known, and split sentences over the 30-word limit.
Satisfy the no-stacked-headings rule by introducing the customer and shared responsibility sections before their subheadings.
TC-MO
force-pushed
the
docs/security-section
branch
from
August 28, 2026 08:36
d81d5fd to
fee4ff8
Compare
Run Actors and Build Actors are the two paths the overview points to. Architecture completes that arc for a general audience, while agent onboarding serves a narrower one and the overview already lists it under common next steps rather than as a path.
The page now sits with the security pages it cross-references. Two links that pointed back to the security overview target the shared responsibility model and the vulnerability disclosure policy instead.
Architecture moved to the security section, so the reorder it prompted no longer applies.
Give each fact one home. The design principles state intent, the cloud infrastructure section states the configuration, and the availability section states the consequence. Drop the residency reference the shared responsibility model does not cover, and name the subject of the orchestrator sentence.
… with a map Three sections on the overview restated the sidebar in prose. Replace them with a short list at the top, which also serves the markdown and llms.txt outputs where no sidebar exists. Drop the secrets guidance the shared responsibility model already covers, and split the opening sentence that promised both how the platform is built and how it is secured.
The dedupe pass treated an explanation and a headline claim as repetition. Put back the gloss on Availability Zone, restore the cross-account guarantee to the design principles where a reader skims for it, and give the reporting address on the overview so a researcher does not have to open another page to find it.
Drop the sentence that announced the page's audience, and name the actor in four sentences where Apify or the platform does the work.
TC-MO
marked this pull request as ready for review
September 3, 2026 09:52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Splits the single security page into an overview, vulnerability disclosure policy, shared responsibility model, and platform architecture. New additions based on drafts from @filakovsky; the security whitepaper stays an external PDF that the docs link rather than duplicate.