Skip to content

Commit 604c49e

Browse files
docs: rewrite guides in Apify docs voice and structure
Short 'Learn how to' intros, a 'Before you start' list, numbered steps in the quick start, imperative sentences, tables for commands and paths, bold-titled notes, and 'Next steps'. Same content and scope; proposals stay clearly marked.
1 parent 7b0335c commit 604c49e

3 files changed

Lines changed: 290 additions & 341 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ See `requirements/*.md` for the full behavioural spec (`system.md`, `api.md`,
1313

1414
## Documentation
1515

16-
- [Quick start](docs/quick-start.md) - prerequisites, starting the runtime (Apify CLI or Docker),
17-
pointing the CLI at it, first push and run, and the proposed `apify local` experience.
18-
- [Local development workflow](docs/local-development.md) - the full dev loop: build, run, inspect,
19-
iterate without rebuilds, IDE debugging, migration/abort rehearsal, multiple users, platform
20-
fallback, limitations, and the ideal state this project is working towards.
16+
- [Quick start](docs/quick-start.md) - start the runtime with Apify CLI or Docker, connect the CLI,
17+
push and run an Actor, view the results, and the proposed `apify local` commands.
18+
- [Local development workflow](docs/local-development.md) - build, run, view results, iterate without
19+
rebuilding, debug with your IDE, test platform events, simulate users, fall back to the platform,
20+
limitations, and proposed improvements.
2121

2222
The sections below are the condensed reference; the docs above are the guided version.
2323

0 commit comments

Comments
 (0)