Skip to content

Commit de61ad5

Browse files
authored
docs: fix links and some headings (#380)
I broke some links in #378, so this update fixes them. Additionally, there are some cosmetic changes, such as updating the titles to the correct case format.
1 parent cd8b05e commit de61ad5

18 files changed

+33
-31
lines changed

docs/01_overview/01_introduction.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: introduction
23
title: Introduction
3-
sidebar_label: Introduction
44
---
55

66
import CodeBlock from '@theme/CodeBlock';
@@ -21,34 +21,34 @@ Actors can be executed locally or on the [Apify platform](https://docs.apify.com
2121

2222
If you're new to Apify, refer to the Apify platform documentation to learn [what Apify is](https://docs.apify.com/platform/about).
2323

24-
## Quick Start
24+
## Quick start
2525

2626
This section provides a quick start guide for creating and running Actors.
2727

2828
### Creating Actors
2929

30-
To create and run Actors using the Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
30+
To create and run Actors using the Apify Console, see the [Console documentation](https://docs.apify.com/platform/console).
3131

32-
For creating and running Python Actors locally, refer to the documentation for [creating and running Python Actors locally](./running_locally).
32+
For creating and running Python Actors locally, refer to the documentation for [creating and running Python Actors locally](./running-actors-locally).
3333

3434
### Guides
3535

3636
Integrate the Apify SDK with popular web scraping libraries by following these guides:
37-
- [Requests or HTTPX](../guides/requests_and_httpx)
38-
- [Beautiful Soup](../guides/beautiful_soup)
37+
- [BeautifulSoup with HTTPX](../guides/beautifulsoup-httpx)
38+
- [Crawlee](../guides/crawlee)
3939
- [Playwright](../guides/playwright)
4040
- [Selenium](../guides/selenium)
4141
- [Scrapy](../guides/scrapy)
4242

43-
### Usage Concepts
43+
### Usage concepts
4444

4545
For a deeper understanding of the Apify SDK's features, refer to the **Usage concepts** section in the sidebar. Key topics include:
4646
- [Actor lifecycle](../concepts/actor-lifecycle)
4747
- [Working with storages](../concepts/storages)
4848
- [Handling Actor events](../concepts/actor-events)
4949
- [Using proxies](../concepts/proxy-management)
5050

51-
## Installing the Apify SDK Separately
51+
## Installing the Apify SDK separately
5252

5353
When creating an Actor using the Apify CLI, the Apify SDK for Python is installed automatically. If you want to install it independently, use the following command:
5454

docs/01_overview/02_running_actors_locally.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Running Actor locally
3-
sidebar_label: Running Actors locally
2+
id: running-actors-locally
3+
title: Running Actors locally
44
---
55

66
import Tabs from '@theme/Tabs';

docs/01_overview/03_actor_structure.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: actor-structure
23
title: Actor structure
3-
sidebar_label: Actor structure
44
---
55

66
import CodeBlock from '@theme/CodeBlock';
@@ -17,7 +17,7 @@ The `.actor/` directory contains the [Actor configuration](https://docs.apify.co
1717
The Actor's runtime dependencies are specified in the `requirements.txt` file,
1818
which follows the [standard requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/).
1919

20-
The Actor's source code is in the `src/` folder. This folder contains two important files: `main.py`, which contains the main function of the Actor, and `__main__.py`, which is the entrypoint of the Actor package, setting up the Actor [logger](../concepts/logging) and executing the Actor's main function via [`asyncio.run()`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
20+
The Actor's source code is in the `src/` folder. This folder contains two important files: `main.py`, which contains the main function of the Actor, and `__main__.py`, which is the entrypoint of the Actor package, setting up the Actor [logger](../concepts/logging) and executing the Actor's main function via [`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
2121

2222
<Tabs>
2323
<TabItem value="main.py" label="main.py" default>

docs/02_guides/01_beautifulsoup_httpx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: beautifulsoup-httpx
23
title: Using BeautifulSoup with HTTPX
3-
sidebar_label: Using BeautifulSoup with HTTPX
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

docs/02_guides/02_crawlee.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: crawlee
23
title: Using Crawlee
3-
sidebar_label: Using Crawlee
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

docs/02_guides/03_playwright.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: playwright
23
title: Using Playwright
3-
sidebar_label: Using Playwright
44
---
55

66
import Tabs from '@theme/Tabs';

docs/02_guides/04_selenium.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: selenium
23
title: Using Selenium
3-
sidebar_label: Using Selenium
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

docs/02_guides/05_scrapy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: scrapy
23
title: Using Scrapy
3-
sidebar_label: Using Scrapy
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

docs/03_concepts/01_actor_lifecycle.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: actor-lifecycle
23
title: Actor lifecycle
3-
sidebar_label: Actor lifecycle
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

docs/03_concepts/02_actor_input.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
id: actor-input
23
title: Actor input
3-
sidebar_label: Actor input
44
---
55

66
import CodeBlock from '@theme/CodeBlock';

0 commit comments

Comments
 (0)