@@ -21,13 +21,43 @@ Our documentation ecosystem consists of:
2121 - [ Python] ( https://docs.apify.com/sdk/python/ )
2222- ** CLI documentation** - [ CLI docs] ( https://docs.apify.com/cli/ )
2323
24- ## Getting started
24+ ## Getting Started
2525
26- Before contributing, read these essential resources:
26+ ** Before contributing, read these essential resources:**
2727
28- - [ Contributing guidelines] ( CONTRIBUTING.md )
29- - [ Documentation style guide] ( CONTRIBUTING.md#documentation-style-guide )
30- - [ AI Assistant Rules Structure] ( CONTRIBUTING.md#ai-assistant-rules-structure )
28+ - [ Contributing guidelines] ( CONTRIBUTING.md ) - Complete setup and contribution process
29+ - [ Documentation style guide] ( CONTRIBUTING.md#documentation-style-guide ) - Writing standards and formatting
30+ - [ AI Assistant Rules Structure] ( CONTRIBUTING.md#ai-assistant-rules-structure ) - AI tool configuration
31+
32+ ### Prerequisites
33+
34+ - ** Node.js 22** (see [ .nvmrc] ( .nvmrc ) )
35+ - ** npm** or ** pnpm**
36+ - ** Git**
37+
38+ ### Quick Setup
39+
40+ ``` bash
41+ # Clone the repository
42+ git clone https://github.com/apify/apify-docs.git
43+ cd apify-docs
44+
45+ # Install dependencies
46+ npm install
47+
48+ # Start development server
49+ npm start
50+ ```
51+
52+ The site will be available at ` http://localhost:3000 `
53+
54+ ### Available Scripts
55+
56+ - ` npm start ` - Start development server with API docs
57+ - ` npm run build ` - Build for production
58+ - ` npm run lint ` - Run all linting checks
59+ - ` npm run lint:fix ` - Fix linting issues automatically
60+ - ` npm run api:rebuild ` - Regenerate API documentation
3161
3262## Documentation architecture
3363
@@ -57,7 +87,7 @@ Our documentation is built using:
5787- ** Automated Deployment** : CI/CD pipeline for continuous updates
5888- ** nginx routing** : Handles subdomain routing and redirects
5989
60- ## Need help
90+ ### Need help
6191
6292- For contribution questions, see our [ Contributing Guidelines] ( CONTRIBUTING.md )
6393- For technical issues, [ create a GitHub issue] ( https://github.com/apify/apify-docs/issues/new )
0 commit comments