docs: Improve Quick Start section in the platform docs #1733

patrikbraborec · 2025-07-28T12:35:26Z

The PR refactors the Quick Start section of the platform documentation. The main changes involve:

Adding clear steps on what to do; this is generally a best practice in quick start documentation
Simplifying the content (the goal should be to show value to new users as quickly as possible)
Adding missing information and links (templates, etc.)

cursor

Comment bugbot run to trigger another review on this PR

package-lock.json

apify-service-account · 2025-07-28T12:38:19Z

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

apify-service-account · 2025-07-28T12:43:10Z

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

B4nan

few formatting nits

sources/platform/actors/development/quick_start/start_locally.md

apify-service-account · 2025-07-29T10:46:14Z

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

apify-service-account · 2025-07-29T10:48:59Z

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

apify-service-account · 2025-07-29T11:09:09Z

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

apify-service-account · 2025-07-29T11:12:40Z

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

apify-service-account · 2025-07-29T11:15:54Z

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

TC-MO

Some changes requested. I also am pondering whether we should have steps at H2, shouldn't they be moved to H3? It would then go as follows:

What you'll learn

Prerequisites

Steps

Next steps

sources/platform/actors/development/quick_start/index.mdx

sources/platform/actors/development/quick_start/start_web_ide.md

sources/platform/actors/development/quick_start/start_locally.md

sources/platform/actors/development/quick_start/start_web_ide.md

sources/platform/actors/development/quick_start/start_locally.md

sources/platform/actors/development/quick_start/start_web_ide.md

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

patrikbraborec · 2025-07-30T09:28:12Z

Thanks!!!

apify-service-account · 2025-07-30T09:28:22Z

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

apify-service-account · 2025-07-30T09:31:26Z

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

apify-service-account · 2025-07-30T10:36:12Z

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

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

patrikbraborec requested a review from TC-MO as a code owner July 28, 2025 12:35

patrikbraborec requested a review from fnesveda July 28, 2025 12:35

cursor bot reviewed Jul 28, 2025

View reviewed changes

package-lock.json Outdated Show resolved Hide resolved

patrikbraborec changed the title ~~Improve Quick Start section in the platform docs~~ docs: Improve Quick Start section in the platform docs Jul 28, 2025

fnesveda approved these changes Jul 28, 2025

View reviewed changes

B4nan reviewed Jul 28, 2025

View reviewed changes

sources/platform/actors/development/quick_start/start_locally.md Outdated Show resolved Hide resolved

sources/platform/actors/development/quick_start/start_locally.md Show resolved Hide resolved

sources/platform/actors/development/quick_start/start_locally.md Show resolved Hide resolved

patrikbraborec added 6 commits July 29, 2025 12:58

docs: Improve Quick Start flow

8620fe4

docs: Quick Start improvement - structure

45c98ed

Finish the first version of new quick start

c301d94

Refactor web ide journey

29cae04

Add what you will learn section to web journey

4e2332b

Revert package-lock.json

be1c2cf

patrikbraborec force-pushed the improve/quick-start branch from 1649f30 to be1c2cf Compare July 29, 2025 11:05

patrikbraborec added 2 commits July 29, 2025 13:09

Fix lint errors

33b0588

Fix lint errors

737d991

TC-MO requested changes Jul 29, 2025

View reviewed changes

patrikbraborec and others added 7 commits July 30, 2025 10:23

Update sources/platform/actors/development/quick_start/index.mdx

303324a

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

Update sources/platform/actors/development/quick_start/index.mdx

d87b1a0

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

Update sources/platform/actors/development/quick_start/index.mdx

911b6da

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

Update sources/platform/actors/development/quick_start/index.mdx

424b2f9

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

Update sources/platform/actors/development/quick_start/index.mdx

44e4289

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

Update sources/platform/actors/development/quick_start/start_locally.md

78056ba

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

Update sources/platform/actors/development/quick_start/start_locally.md

6cb41c3

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

patrikbraborec and others added 20 commits July 30, 2025 11:24

Update sources/platform/actors/development/quick_start/index.mdx

29b3c3b

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

Update sources/platform/actors/development/quick_start/start_locally.md

afbcabe

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

Update sources/platform/actors/development/quick_start/start_locally.md

3d88d00

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

Update sources/platform/actors/development/quick_start/start_locally.md

79818ac

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

Update sources/platform/actors/development/quick_start/start_locally.md

ad65280

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

Update sources/platform/actors/development/quick_start/start_locally.md

c80168b

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

Update sources/platform/actors/development/quick_start/start_locally.md

c29c047

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

Update sources/platform/actors/development/quick_start/start_locally.md

f22dc79

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

Update sources/platform/actors/development/quick_start/start_locally.md

f83174b

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

Update sources/platform/actors/development/quick_start/start_locally.md

86cb0ee

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

Update sources/platform/actors/development/quick_start/start_locally.md

ca0d675

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

Update sources/platform/actors/development/quick_start/start_locally.md

0c4ba41

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

Update sources/platform/actors/development/quick_start/start_locally.md

581b1e4

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

462cf25

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

1c842f0

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

389b6f8

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

9872c41

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

c4e15fd

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

e5f458b

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

Update sources/platform/actors/development/quick_start/start_web_ide.md

5dede40

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

Fix links

95760db

patrikbraborec merged commit bdaf79a into master Jul 30, 2025
9 checks passed

patrikbraborec deleted the improve/quick-start branch July 30, 2025 10:37

patrikbraborec mentioned this pull request Jul 30, 2025

Refactor Quick Start #1702

Closed

patrikbraborec restored the improve/quick-start branch August 5, 2025 07:52

daveomri pushed a commit to daveomri/apify-docs that referenced this pull request Sep 3, 2025

docs: Improve Quick Start section in the platform docs (apify#1733)

e8453ae

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

docs: Improve Quick Start section in the platform docs #1733

docs: Improve Quick Start section in the platform docs #1733

Uh oh!

Conversation

patrikbraborec commented Jul 28, 2025

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

apify-service-account commented Jul 28, 2025

Uh oh!

apify-service-account commented Jul 28, 2025

Uh oh!

B4nan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apify-service-account commented Jul 29, 2025

Uh oh!

apify-service-account commented Jul 29, 2025

Uh oh!

apify-service-account commented Jul 29, 2025

Uh oh!

apify-service-account commented Jul 29, 2025

Uh oh!

apify-service-account commented Jul 29, 2025

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

What you'll learn

Prerequisites

Steps

Next steps

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patrikbraborec commented Jul 30, 2025

Uh oh!

apify-service-account commented Jul 30, 2025

Uh oh!

apify-service-account commented Jul 30, 2025

Uh oh!

apify-service-account commented Jul 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants