Skip to content

refactor: reorganize documentation structure#850

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

refactor: reorganize documentation structure#850
patrikbraborec merged 4 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-sdk-js and apify-sdk-python
  • 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

Restructure docs from flat structure to numbered hierarchical organization
(01_introduction, 02_concepts, 03_guides) matching the pattern used in
apify-sdk-js and apify-sdk-python repos.

Split monolithic getting-started.md into focused topic pages and apply
matching changes to versioned docs (version-2).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

two small issues, otherwise

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

all other examples use MY-APIFY-TOKEN. I would make it consistent

patrikbraborec and others added 2 commits March 3, 2026 08:26
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@patrikbraborec patrikbraborec marked this pull request as ready for review March 3, 2026 07:43
@patrikbraborec patrikbraborec merged commit 5541635 into master Mar 3, 2026
8 checks passed
@patrikbraborec patrikbraborec deleted the docs/restructure-documentation branch March 3, 2026 09:10
patrikbraborec added a commit to apify/apify-client-python 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-client-js#850](apify/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](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
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.

2 participants