Skip to content

Commit cf6ddc6

Browse files
authored
docs: remove redundant H1's (#2056)
<!-- CURSOR_SUMMARY --> > [!NOTE] > Removes redundant in-body H1s and standardizes frontmatter titles across Academy docs, with minor copy edits; updates Vale config and accepted vocabulary. > > - **Docs cleanup & consistency**: > - Remove redundant top-level `#` headings across many `sources/academy/**` pages; rely on frontmatter titles. > - Normalize/adjust frontmatter titles (e.g., “Dynamic pages and single-page applications”, “The Apify API”, “Puppeteer and Playwright course”, etc.). > - Minor copy edits: capitalization (e.g., `CAPTCHAs`), small wording/link tweaks, section heading level fixes, typo/grammar nits, and note/guide clarifications. > - **Linting/Style**: > - `.vale.ini`: disable `Microsoft.Units` rule. > - Vocabulary: expand accepted terms (e.g., `reCAPTCHA?`, product/tool names, acronyms, brands) in `.github/styles/.../accept.txt`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 04f14b0. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
1 parent 58b72c9 commit cf6ddc6

File tree

120 files changed

+53
-280
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+53
-280
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ idempotency
4545
backoff
4646

4747
Authy
48-
reCaptcha
48+
reCAPTCHA?
4949
OAuth
5050
untrusted
5151
unencrypted

.vale.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Microsoft.Foreign = NO
2626
Microsoft.We = NO
2727
Microsoft.Quotes = NO
2828
Microsoft.Auto = NO
29+
Microsoft.Units = NO
2930
Microsoft.URLFormat = NO
3031
Microsoft.GeneralURL = NO
3132

sources/academy/glossary/concepts/dynamic_pages.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
title: Dynamic pages
2+
title: Dynamic pages and single-page applications
33
description: Understand what makes a page dynamic, and how a page being dynamic might change your approach when writing a scraper for it.
44
sidebar_position: 8.3
55
slug: /concepts/dynamic-pages
66
---
77

8-
# Dynamic pages and single-page applications (SPAs) {#dynamic-pages}
9-
108
**Understand what makes a page dynamic, and how a page being dynamic might change your approach when writing a scraper for it.**
119

1210
---

sources/academy/glossary/concepts/http_cookies.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sidebar_position: 8.2
55
slug: /concepts/http-cookies
66
---
77

8-
# HTTP cookies {#cookies}
9-
108
**Learn a bit about what cookies are, and how they are utilized in scrapers to appear logged-in, view specific data, or even avoid blocking.**
119

1210
---

sources/academy/glossary/concepts/http_headers.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sidebar_position: 8.1
55
slug: /concepts/http-headers
66
---
77

8-
# HTTP headers {#headers}
9-
108
**Understand what HTTP headers are, what they're used for, and three of the biggest differences between HTTP/1.1 and HTTP/2 headers.**
119

1210
---

sources/academy/glossary/concepts/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ category: glossary
66
slug: /concepts
77
---
88

9-
# Concepts 🤔 {#concepts}
10-
119
**Learn about some common yet tricky concepts and terms that are used frequently within the academy, as well as in the world of scraper development.**
1210

1311
---

sources/academy/glossary/concepts/robot_process_automation.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sidebar_position: 8.7
55
slug: /concepts/robotic-process-automation
66
---
77

8-
# What is robotic process automation (RPA)? {#what-is-robotic-process-automation-rpa}
9-
108
**Learn the basics of robotic process automation. Make your processes on the web and other software more efficient by automating repetitive tasks.**
119

1210
---

sources/academy/glossary/glossary.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ category: glossary
66
slug: /glossary
77
---
88

9-
# Why a glossary? {#why-a-glossary}
10-
119
**Browse important web scraping concepts, tools and topics in succinct articles explaining common web development terms in a web scraping and automation context.**
1210

1311
---

sources/academy/glossary/tools/apify_cli.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sidebar_position: 9.1
55
slug: /tools/apify-cli
66
---
77

8-
# The Apify CLI {#the-apify-cli}
9-
108
**Learn about, install, and log into the Apify CLI - your best friend for interacting with the Apify platform via your terminal.**
119

1210
---
@@ -15,7 +13,7 @@ The [Apify CLI](/cli) helps you create, develop, build and run Apify Actors, and
1513

1614
## Installing {#installing}
1715

18-
To install the Apfiy CLI, you'll first need npm, which comes preinstalled with Node.js. If you haven't yet installed Node, learn how to do that [here](../../webscraping/scraping_basics_javascript/data_extraction/computer_preparation.md). Additionally, make sure you've got an Apify account, as you will need to log in to the CLI to gain access to its full potential.
16+
To install the Apfiy CLI, you'll first need npm, which comes preinstalled with Node.js. If you haven't yet installed Node, [learn how to do that](../../webscraping/scraping_basics_javascript/data_extraction/computer_preparation.md). Additionally, make sure you've got an Apify account, as you will need to log in to the CLI to gain access to its full potential.
1917

2018
Open up a terminal instance and run the following command:
2119

sources/academy/glossary/tools/edit_this_cookie.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ sidebar_position: 9.7
55
slug: /tools/edit-this-cookie
66
---
77

8-
# What's EditThisCookie? {#what-is-it}
9-
108
**Learn how to add, delete, and modify different cookies in your browser for testing purposes using the EditThisCookie Chrome extension.**
119

1210
---

0 commit comments

Comments
 (0)