Skip to content

docs: Make titles stand on their own #1751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 1, 2025
Merged

docs: Make titles stand on their own #1751

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70ffcd2
docs: Make titles stand on their own
patrikbraborec Aug 1, 2025
11276f0
Fix title uppercase
patrikbraborec Aug 1, 2025
10232ef
Fix title uppercase
patrikbraborec Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion sources/platform/actors/development/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: Development
title: Actor development
Copy link
Contributor

@TC-MO TC-MO Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don' think this is a good change, it already is inferred from the structure that this development is in relation to Actors. I would leave original title. Also this changes the title on the right side, which can get cluttered unnecessarily.

Copy link
Member

@jancurn jancurn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with keeping the sidebar label, but IMO this change makes sense, so that you know what you're looking at without having to look at the menu

desc: Read about the technical part of building Apify Actors. Learn to define Actor inputs, build new versions, persist Actor state, and choose base Docker images.
sidebar_position: 7.4
slug: /actors/development
---

# Actor development
Copy link
Contributor

@TC-MO TC-MO Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unnecessary, if this is to be the same as title front matter then docusaurus uses it automatically. This is only used when H1 is to be different than title


**Read about the technical part of building Apify Actors. Learn to define Actor inputs, build new versions, persist Actor state, and choose base Docker images.**

---
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/actors/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ import CardGrid from "@site/src/components/CardGrid";

<CardGrid>
<Card
title="Running Actors"
title="Running actors"
desc="In this section, you learn how to run Apify Actors. You will learn about their configuration, versioning, data retention, usage, and pricing."
to="/platform/actors/running"
/>
<Card
title="Development"
title="Actor development"
desc="Read about the technical part of building Apify Actors. Learn to define Actor inputs, build new versions, persist Actor state, and choose base Docker images."
to="/platform/actors/development"
/>
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/running/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 7.1
slug: /actors/running
---

# Running
# Running Actors

**In this section, you learn how to run Apify Actors using Apify Console or programmatically. You will learn about their configuration, versioning, data retention, usage, and pricing.**

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/console/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,4 @@ You can also navigate Apify Console via keyboard shortcuts.
| [Proxy](/platform/proxy)| View your proxy usage & credentials |
| [Storage](/platform/storage)| View stored results of your runs in various data formats. |
| [Billing](/platform/console/billing)| Billing information, statistics and invoices. |
| [Settings](/platform/console/settings)| Settings of your account. |
| [Settings](/platform/console/settings)| Console settings of your account. |
Copy link
Contributor

@TC-MO TC-MO Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the point of that change? The doc is within Console section, and this refers to Account settings. Moreover this is not specific Console settings , rather Apify acc settings.

Copy link
Member

@jancurn jancurn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, this wasn't needed

2 changes: 1 addition & 1 deletion sources/platform/console/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Settings
title: Console settings
Copy link
Contributor

@TC-MO TC-MO Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed as explained above. This is within Console section.

Copy link
Member

@jancurn jancurn Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @TC-MO, IMO it makes total sense to make the page titles work on their own, so that you don't need to look in the left menu to figure what you're looking at. This change also makes the open graph images work better, and provides better context for LLMs who also don't see the menu structure.

Copy link
Contributor

@TC-MO TC-MO Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On one hand I completely agree that titles should work as standalone context for open graph and LLMs. That being said isn't this page about general Apify account settings rather than specific "Console settings"? It lives within the Console section, but it covers account-wide configurations. This seems similar to the case with the table mentioned above.

Moreover if you take a look at the UI labels within Console, I deliberately chose these titles so they also reflect the naming conventions from Console.

Copy link
Member

@jancurn jancurn Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough, "Account settings" is a better name

description: Learn about the Apify Console settings for the account, integrations, organization management, and notification preferences.
sidebar_position: 4
category: platform
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/console/store.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Store
title: Apify Store
description: Explore Apify Store, browse and select Actors, search by criteria, sort by relevance, and adjust settings for immediate or future runs.
sidebar_position: 2
category: platform
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/console/two-factor-authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Two-factor authentication
title: Two-factor authentication setup
description: Learn about Apify Console's two-factor authentication process and how to set it up.
sidebar_position: 5
category: platform
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/integrations/actors/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Actor-to-Actor
title: Actor-to-Actor integration
description: Learn how to integrate with other Actors and tasks.
sidebar_label: Actor-to-Actor
sidebar_label: Actor-to-Actor integration
Copy link
Member

@jancurn jancurn Aug 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sidebar change was not necessary and actually it makes it worse

slug: /integrations/actors
---

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integrations/programming/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: API integration
description: Learn how to integrate with Apify via API.
sidebar_label: API
sidebar_label: API integration
sidebar_position: 1
slug: /integrations/api
---
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/integrations/programming/webhooks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Webhooks integration
title: Webhook integration
description: Learn how to integrate multiple Apify Actors or external systems with your Actor or task run. Send alerts when your Actor run succeeds or fails.
sidebar_position: 2
sidebar_label: Webhooks
sidebar_label: Webhook integration
slug: /integrations/webhooks
---

Expand Down
4 changes: 2 additions & 2 deletions sources/platform/proxy/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Usage
title: Proxy Usage
description: Learn how to configure and use Apify Proxy. See the required parameters such as the correct username and password.
sidebar_position: 10.1
slug: /proxy/usage
---

# Usage
# Proxy Usage

**Learn how to configure and use Apify Proxy. See the required parameters such as the correct username and password.**

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/storage/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Usage
title: Usage of storage
Copy link
Contributor

@TC-MO TC-MO Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For better syntactic parallelism with the Proxy usage, I'd suggest this wording instead.

Storage usage

description: Learn how to effectively use Apify's storage options. Understand key aspects of data retention, rate limiting, and secure sharing.
sidebar_position: 9.1
category: platform
Expand Down
Loading