Skip to content

refactor: restructure documentation#647

Merged
patrikbraborec merged 3 commits intomasterfrom
docs/restructure-documentation
Mar 3, 2026
Merged

refactor: restructure documentation#647
patrikbraborec merged 3 commits intomasterfrom
docs/restructure-documentation

Conversation

@patrikbraborec
Copy link
Contributor

Summary

  • Restructured documentation from flat structure to numbered hierarchical organization (01_introduction, 02_concepts, 03_guides), matching the pattern used in apify-client-js#850
  • Renamed 01_overview to 01_introduction with simplified overview and separate quick start page
  • Renamed 03_examples to 03_guides
  • Simplified overview page by removing content duplicated in the quick start guide (authentication, running Actors, providing input, getting results)
  • Updated sidebar, docusaurus config, and landing page redirect

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added the t-c&c Team covering store and finance matters. label Feb 24, 2026
@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.62%. Comparing base (230bb64) to head (e6ce93b).
⚠️ Report is 14 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #647   +/-   ##
=======================================
  Coverage   96.62%   96.62%           
=======================================
  Files          45       45           
  Lines        4271     4271           
=======================================
  Hits         4127     4127           
  Misses        144      144           
Flag Coverage Δ
integration 94.56% <ø> (-0.12%) ⬇️
unit 75.60% <ø> (ø)

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.

@patrikbraborec patrikbraborec requested a review from TC-MO February 26, 2026 12:58
Copy link
Contributor

@vdusek vdusek left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

LGTM, but I noticed that neither guides nor concepts have any description field in frontmatter. Might slightly impact SEO - This is not result of the PR, but a pre-existing issue.

@patrikbraborec patrikbraborec marked this pull request as ready for review March 3, 2026 07:43
@patrikbraborec patrikbraborec merged commit 3fee70a into master Mar 3, 2026
24 checks passed
@patrikbraborec patrikbraborec deleted the docs/restructure-documentation branch March 3, 2026 09:10
patrikbraborec pushed a commit to apify/apify-docs that referenced this pull request Mar 3, 2026
- [apify-client-js PR
#850](apify/apify-client-js#850):
getting-started → introduction/quick-start, examples → guides/examples
- [apify-client-python
#647](apify/apify-client-python#647): overview →
docs root, examples/* → guides/*
- Remove stale redirect of python /docs to non-existent
/docs/overview/introduction

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-c&c Team covering store and finance matters.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants