docs: merge overview pages #732

TC-MO · 2026-01-08T16:42:01Z

No description provided.

fix capitalization of Actor changes to formatting streamlining prose

codecov · 2026-01-08T16:43:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.90%. Comparing base (ed35b6d) to head (190ca50).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #732      +/-   ##
==========================================
- Coverage   81.98%   81.90%   -0.08%     
==========================================
  Files          46       46              
  Lines        2681     2681              
==========================================
- Hits         2198     2196       -2     
- Misses        483      485       +2

Flag	Coverage Δ
integration	`56.13% <ø> (ø)`
unit	`67.84% <ø> (-0.08%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

marcel-rbro · 2026-01-09T10:38:11Z

docs/01_overview/overview.mdx

@@ -0,0 +1,163 @@
+---


General note:
Is it possible to move the overview page one level up, so that it is not in the Overview section? It's kinda weird UX-wise.

Yeah I was afraid that might happen. I think if we rename it to index.md it should not be separate openable section

marcel-rbro · 2026-01-09T10:39:40Z

docs/01_overview/overview.mdx

+<Tabs>
+    <TabItem value="main.py" label="main.py" default>
+        <CodeBlock language="python">{
+`from apify import Actor
+${''}
+async def main():
+    async with Actor:
+        Actor.log.info('Actor input:', await Actor.get_input())
+        await Actor.set_value('OUTPUT', 'Hello, world!')`
+        }</CodeBlock>
+    </TabItem>
+    <TabItem value="__main__.py" label="__main.py__">
+        <CodeBlock language="python">{
+`import asyncio
+import logging
+${''}
+from apify.log import ActorLogFormatter
+${''}
+from .main import main
+${''}
+handler = logging.StreamHandler()
+handler.setFormatter(ActorLogFormatter())
+${''}
+apify_logger = logging.getLogger('apify')
+apify_logger.setLevel(logging.DEBUG)
+apify_logger.addHandler(handler)
+${''}
+asyncio.run(main())`
+        }</CodeBlock>
+    </TabItem>
+</Tabs>


Consider adding some code comments?

marcel-rbro · 2026-01-09T10:42:18Z

docs/01_overview/overview.mdx

+
+### Creating Actors
+
+To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).


"through Apify Console"
Is through used in this context? I'd rather just use "in".

Suggested change

To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).

To create and run Actors in Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).

marcel-rbro · 2026-01-09T10:47:33Z

docs/01_overview/overview.mdx

+
+## Requirements
+
+The Apify SDK requires Python version 3.8 or above to run Python Actors locally.


The docs previously said that the required version is 3.10 or above. Is this updated version correct?

Good point, I'll reach out and confirm the required version as client & sdk diverge here

marcel-rbro · 2026-01-09T10:55:39Z

docs/01_overview/overview.mdx

+
+## Adding dependencies
+
+First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.


Suggested change

First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.

First, add the dependencies in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.

marcel-rbro · 2026-01-09T10:56:20Z

docs/01_overview/overview.mdx

+    </TabItem>
+</Tabs>
+
+Then install the dependencies:


Suggested change

Then install the dependencies:

Finally, install the dependencies:

vdusek

When running it locally, clicking "Docs" or "Get Started" redirects to
http://localhost:3000/sdk/python/docs/overview/introduction, which results in a 404.

TC-MO added 2 commits January 8, 2026 17:17

docs: merge overview pages

4737621

further changes

aaf5b50

fix capitalization of Actor changes to formatting streamlining prose

TC-MO self-assigned this Jan 8, 2026

TC-MO added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Jan 8, 2026

TC-MO requested review from marcel-rbro and patrikbraborec January 9, 2026 09:09

Merge branch 'master' into consolidate-overview

190ca50

TC-MO marked this pull request as ready for review January 9, 2026 09:12

marcel-rbro requested changes Jan 9, 2026

View reviewed changes

vdusek requested changes Jan 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: merge overview pages #732

docs: merge overview pages #732

Uh oh!

TC-MO commented Jan 8, 2026

Uh oh!

codecov bot commented Jan 8, 2026 •

edited

Loading

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

TC-MO Jan 9, 2026

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

TC-MO Jan 9, 2026

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

marcel-rbro Jan 9, 2026

Uh oh!

vdusek left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		### Creating Actors

		To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).

	To create and run Actors through Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
	To create and run Actors in Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).


		## Requirements

		The Apify SDK requires Python version 3.8 or above to run Python Actors locally.


		## Adding dependencies

		First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.

	First, add them in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.
	First, add the dependencies in the [`requirements.txt`](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file in the Actor source folder.

	Then install the dependencies:
	Finally, install the dependencies:

docs: merge overview pages #732

Are you sure you want to change the base?

docs: merge overview pages #732

Uh oh!

Conversation

TC-MO commented Jan 8, 2026

Uh oh!

codecov bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vdusek left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Jan 8, 2026 •

edited

Loading