docs: Restructure documentation with separate introduction section#771
docs: Restructure documentation with separate introduction section#771patrikbraborec wants to merge 4 commits intomasterfrom
Conversation
This reverts commit 2ed03ca.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #771 +/- ##
==========================================
+ Coverage 81.91% 85.53% +3.62%
==========================================
Files 46 46
Lines 2693 2697 +4
==========================================
+ Hits 2206 2307 +101
+ Misses 487 390 -97
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Consolidate the introduction section by merging installation info into the overview page, removing the separate installation page, and flattening the sidebar navigation. Update slugs and redirect paths to use /overview. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@TC-MO I did the same changes as in JS SDK (structure-wise). Please check it. |
TC-MO
left a comment
TC-MO
left a comment
There was a problem hiding this comment.
One big ticket item - but seems that can be future work we discussed previously.
Other than that, remove gerunds from headings and we should be okay to merge this restructure & work further on the content
docs/01_introduction/index.mdx
Outdated
| The Apify SDK for Python is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use: | ||
|
|
||
| ```bash | ||
| pip install apify | ||
| ``` |
There was a problem hiding this comment.
I think I already mentioned it in one of the previous reviews, but why are we putting SDK installation through CLI first and foremost? This feels backwards to me, we should:
- First mention how to install it manually
- Mention that you can also utilize CLI to scaffold a project and get it installed as dependency
- Admonition about programmatic use through Client
There was a problem hiding this comment.
But then again this might be something to do quickly after we merge this restructure
| To create and run Actors in Apify Console, refer to the [Console documentation](/platform/actors/development/quick-start/web-ide). | ||
|
|
||
| To create a new Apify Actor on your computer, you can use the [Apify CLI](/cli), and select one of the [Python Actor templates](https://apify.com/templates?category=python). |
There was a problem hiding this comment.
same here as above, those two should be mentioned only after we explain a simple way to interact with SDK
There was a problem hiding this comment.
but again this is further down the line after restructure
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
Simplify the overview by linking to the standalone quick start page instead of duplicating its content. Add Python version requirement to the installation section and update the code example. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@TC-MO thanks, I little bit edited the overview (aligned it with JS SDK). I agree with you about the content. I would address in the follow up PRs, though. |
2 participants
Summary
Re-applies the documentation restructuring from #740 (which was reverted in #763).
/docs/introductionTest plan
🤖 Generated with Claude Code