docs: Restructure documentation with separate introduction section#771
Merged
patrikbraborec merged 4 commits intomasterfrom Feb 18, 2026
Merged
docs: Restructure documentation with separate introduction section#771patrikbraborec merged 4 commits intomasterfrom
patrikbraborec merged 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>
Contributor
Author
|
@TC-MO I did the same changes as in JS SDK (structure-wise). Please check it. |
TC-MO
requested changes
Feb 16, 2026
Contributor
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
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>
Contributor
Author
|
@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. |
TC-MO
approved these changes
Feb 17, 2026
patrikbraborec
added a commit
to apify/apify-client-js
that referenced
this pull request
Mar 3, 2026
## Summary - Restructured documentation from flat structure to numbered hierarchical organization (`01_introduction`, `02_concepts`, `03_guides`), matching the pattern used in [apify-sdk-js](apify/apify-sdk-js#542) and [apify-sdk-python](apify/apify-sdk-python#771) - Split monolithic `getting-started.md` into focused topic pages (quick start, usage patterns, error handling, convenience functions, pagination, bundled environments) - Restructured quick start into numbered steps (authenticate, run Actor, get results) - Applied matching changes to versioned docs (version-2) - Cleaned up leftover artifacts from previous restructuring attempt 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
TC-MO
added a commit
that referenced
this pull request
Mar 10, 2026
The restructuring in #771 updated the navbar link target to `docs/introduction`, but the introduction page has `slug: /overview` in its frontmatter, so Docusaurus still serves it at `/docs/overview`. This caused the submenu Docs link to 404. Reverts the one-line config change to restore the working URL. Fixes #825 Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
TC-MO
added a commit
that referenced
this pull request
Mar 10, 2026
The restructuring in #771 updated the navbar link target to `docs/introduction`, but the introduction page has `slug: /overview` in its frontmatter, so Docusaurus still serves it at `/docs/overview`. This caused the submenu Docs link to 404. Reverts the one-line config change to restore the working URL. Fixes #825 Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-applies the documentation restructuring from #740 (which was reverted in #763).
/docs/introductionTest plan
🤖 Generated with Claude Code