Skip to content

Commit aa02972

Browse files
authored
docs: Adjust README to the company style guide (#2413)
- Unify capitalization (sentence case) - Get rid of `our` and ampersands
1 parent d83b144 commit aa02972

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Apify Documentation
1+
# Apify documentation
22

33
[![Check & Release](https://github.com/apify/apify-docs/actions/workflows/test.yaml/badge.svg)](https://github.com/apify/apify-docs/actions/workflows/test.yaml)
44

55
## Overview
66

7-
This repository is the home of Apify's documentation, available at [docs.apify.com](https://docs.apify.com/). The documentation uses [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) & [Docusaurus](https://docusaurus.io/).
7+
This repository is the home of Apify's documentation, available at [docs.apify.com](https://docs.apify.com/). The documentation uses [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) and [Docusaurus](https://docusaurus.io/).
88

99
## Documentation structure
1010

11-
Our documentation ecosystem consists of:
11+
Documentation ecosystem consists of:
1212

1313
- **Platform documentation**: Located in the [`/sources`](https://github.com/apify/apify-docs/tree/master/sources) directory
1414
- **Academy**: Platform-independent courses on scraping technique. Located in the [/sources](https://github.com/apify/apify-docs/tree/master/sources) directory
@@ -21,7 +21,7 @@ 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

2626
**Before contributing, read these essential resources:**
2727

@@ -35,7 +35,7 @@ Our documentation ecosystem consists of:
3535
- **npm** or **pnpm**
3636
- **Git**
3737

38-
### Quick Setup
38+
### Quick setup
3939

4040
```bash
4141
# Clone the repository
@@ -51,7 +51,7 @@ npm start
5151

5252
The site will be available at `http://localhost:3000`
5353

54-
### Available Scripts
54+
### Available scripts
5555

5656
- `npm start` - Start development server with API docs
5757
- `npm run build` - Build for production
@@ -61,15 +61,15 @@ The site will be available at `http://localhost:3000`
6161

6262
## Documentation architecture
6363

64-
Our documentation consists of these main sections:
64+
Documentation consists of these main sections:
6565

6666
1. **Academy**: Collection of mostly platform-independent courses on scraping techniques.
6767
2. **Platform**: Main documentation for using Apify as a product.
6868
3. **API**: API reference and client libraries documentation.
6969
4. **SDK**: SDK libraries documentation.
7070
5. **CLI**: Documentation for building code and platform interaction.
7171

72-
### Source Repositories
72+
### Source repositories
7373
<!-- vale off -->
7474
- apify-docs (this repository)
7575
- apify-client-js
@@ -80,15 +80,15 @@ Our documentation consists of these main sections:
8080
<!-- vale on -->
8181
## Architecture
8282

83-
Our documentation is built using:
83+
Documentation is built using:
8484

85-
- **Docusaurus**: Powers our documentation platform
86-
- **Shared Theme**: Custom `@apify/docs-theme` package
87-
- **Automated Deployment**: CI/CD pipeline for continuous updates
85+
- **Docusaurus**: Powers the documentation platform
86+
- **Shared theme**: Custom `@apify/docs-theme` package
87+
- **Automated deployment**: CI/CD pipeline for continuous updates
8888
- **nginx routing**: Handles subdomain routing and redirects
8989

9090
### Need help
9191

92-
- For contribution questions, see our [Contributing Guidelines](CONTRIBUTING.md)
92+
- For contribution questions, see [Contributing guidelines](CONTRIBUTING.md)
9393
- For technical issues, [create a GitHub issue](https://github.com/apify/apify-docs/issues/new)
9494

0 commit comments

Comments
 (0)