Skip to content

docs: restructure documentation to align with SDK and Client docs - #2197

Open
vdusek wants to merge 11 commits into
masterfrom
docs/restructure
Open

vdusek wants to merge 11 commits into
masterfrom
docs/restructure

Conversation

@vdusek

@vdusek vdusek commented Aug 26, 2026 •

Copy link
Copy Markdown
Collaborator

Aligns the docs structure with apify-sdk-python and apify-client-python.

  • New Concepts section (26 pages in 7 groups). Component pages move here from Guides, and new pages cover requests, crawling context, events, statistics, configuration, and logging.
  • Guides keep only task-oriented how-tos. The Examples section is dissolved into Concepts and Guides.
  • Other sidebar categories stay the same.
  • Every moved or removed URL gets a redirect. The frozen 1.11 and 0.6 versions are left untouched, so the new structure is live at /docs/next until the next snapshot.

✍️ Drafted by Claude Code

@vdusek vdusek added t-tooling Issues with this label are in the ownership of the tooling team. adhoc Ad-hoc unplanned task added during the sprint. labels Aug 26, 2026
@vdusek vdusek self-assigned this Aug 26, 2026
@github-actions github-actions Bot added this to the 148th sprint - Tooling team milestone Aug 26, 2026
@codecov

codecov Bot commented Aug 26, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.05%. Comparing base (508f544) to head (ab1f6ac).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2197      +/-   ##
==========================================
- Coverage   94.11%   94.05%   -0.06%     
==========================================
  Files         184      184              
  Lines       13644    13644              
==========================================
- Hits        12841    12833       -8     
- Misses        803      811       +8     
Flag Coverage Δ
unit 94.05% <ø> (-0.06%) ⬇️

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

☔ View full report in Codecov by Harness.
📢 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.

- 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
vdusek marked this pull request as ready for review October 16, 2026 11:34
@vdusek
vdusek requested review from Mantisus and Pijukatel October 16, 2026 11:34

@Mantisus Mantisus left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@apify-approval-mirror apify-approval-mirror Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Mirroring approval from @Mantisus.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants