Skip to content

Commit 7c4fdb2

Browse files
committed
enhance README & CONTRIBUTING guidelines
1 parent 755a735 commit 7c4fdb2

File tree

3 files changed

+46
-12
lines changed

3 files changed

+46
-12
lines changed

.github/styles/config/vocabularies/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,4 @@ walkthroughs?
123123

124124
ul
125125
[Aa]gno
126+
pnpm

CONTRIBUTING.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010

1111
### Prerequisites
1212

13-
1. Git
14-
2. Node.js
15-
3. GitHub access
13+
1. **Git**
14+
2. **Node.js 22** (see [.nvmrc](.nvmrc) file)
15+
3. **GitHub access**
16+
4. **npm** or **pnpm** package manager
1617

1718
### Installation steps
1819

@@ -312,21 +313,21 @@ Add languages by adding new folders at the appropriate path level.
312313

313314
### Linting
314315

315-
1. Markdown:
316+
1. **Markdown**:
316317

317318
```bash
318319
npm run lint:md # Checks for any issues using markdownlint
319320
npm run lint:md:fix # Applies fixes
320321
```
321322

322-
2. Code:
323+
2. **Code**:
323324

324325
```bash
325326
npm run lint:code # Checks .js & .ts files
326327
npm run lint:code:fix # Applies fixes
327328
```
328329

329-
3. Prose:
330+
3. **Prose**:
330331

331332
- Use [Vale](https://vale.sh/) for content linting
332333
- Configure exceptions in `accepts.txt`
@@ -347,3 +348,5 @@ Add languages by adding new folders at the appropriate path level.
347348

348349
- [Docusaurus documentation](https://docusaurus.io/docs)
349350
- [Vale style guide](https://vale.sh/docs)
351+
- [OpenAPI specification](https://spec.openapis.org/oas/v3.1.0)
352+
- [Redocly documentation](https://redocly.com/docs/)

README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Comments
 (0)