docs: restructure documentation to align with SDK and Client docs - #2197
Draft
vdusek wants to merge 2 commits into
Draft
docs: restructure documentation to align with SDK and Client docs#2197vdusek wants to merge 2 commits into
vdusek wants to merge 2 commits into
Conversation
- Add a Concepts section holding the component and abstraction pages moved from Guides, plus a new Logging page. - Merge the Examples section into Concepts and Guides: each example is folded into its related page or combined into a new guide (Crawling links, Stopping and resuming crawlers), and redundant duplicates are dropped. - Number the section directories and files to drive sidebar order, matching the apify-sdk-python and apify-client-python docs conventions. - Enable @docusaurus/plugin-client-redirects with version-aware redirects for every moved URL. - Update the navbar, footer, homepage, README, and lint config paths, and add frontmatter descriptions to pages that lacked them.
vdusek
added
t-tooling
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2197 +/- ##
==========================================
+ Coverage 93.61% 93.75% +0.14%
==========================================
Files 181 181
Lines 12825 12825
==========================================
+ Hits 12006 12024 +18
+ Misses 819 801 -18
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Aligns the Python docs structure with apify-sdk-python and apify-client-python: Quick start, Introduction, Concepts, Guides, Deployment, Upgrading, Changelog.
01_quick-start...06_upgrading) so autogenerated sidebars keep the intended order. Public URLs are unaffected, since Docusaurus strips theNN_prefixes.website/docusaurus.config.js, version-guarded so the frozen 1.9 and 0.6 snapshots keep serving their real pages and start redirecting only once a new-structure version becomes latest.The new structure is served at
/docs/next/*until the next version snapshot, so three homepage links point there for now; a comment inwebsite/src/pages/index.jsmarks them for switching to unversioned URLs after the snapshot.Verified locally with the full docs build (
onBrokenLinks: 'throw', which PR CI does not run), ruff, ty, markdownlint, and oxlint/oxfmt.✍️ Drafted by Claude Code