feat: IA v3 clean slate#2516
Draft
TC-MO wants to merge 21 commits into
Draft
Conversation
…prefix - Move actors/development/quick-start/ → get-started/build-an-actor/ - Move storage/, proxy/ under actors/ - Move schedules.md, monitoring.md under actors/running/ - Flatten console/ into account/ (billing, store, settings, console, 2FA) - Move collaboration/ → account/collaboration/, organization_account → organization - Move security.md, limits.md → account/, promoted in sidebar (sidebar_position) - Drop /platform/ URL prefix: routeBasePath: 'platform' → '/' - Update slugs in all moved files to new IA paths (no /platform/) - Update relative cross-references in 100+ markdown files - Rewrite homepage_content.json + src/pages/index.tsx links - Add named sidebars (getStarted, actors, integrations, account) - Add 17 _category_.json files for collapsed categories with v3 labels (Develop, Run and manage, Publish and monetize, AI and LLMs, etc.) - Add get-started/index.mdx and account/index.mdx as router pages - Relax onBrokenMarkdownLinks/Images and onBrokenLinks to warn (preview) - Move orphan images alongside their content (proxy, storage, schedules) - Delete sources/platform/index.mdx (homepage now src/pages/index.tsx only)
…ations/Account, consolidate API/SDK/CLI into APIs & SDKs - Replace 6-item nav (Academy | Platform | API ▼ | SDK ▼ | CLI | Open source ▼) with 7-item v3 nav split across PRODUCT (left) and ECOSYSTEM (right) zones: PRODUCT: Get started | Actors | Integrations | Account | APIs & SDKs ▼ ECOSYSTEM: Academy | Open source ▼ - APIs & SDKs dropdown bundles: API Reference, SDK for JS, SDK for Python, Client for JS, Client for Python, CLI - Move Academy and Open source to position: 'right' - Update SearchBar matchesCurrentInstance to recognize new top-level paths - Update DocItemContent allowedPaths for LLMButtons (drop /platform, add new) - Update footer Learn section: replace Platform link with Get started + Actors
Index pages had legacy global positions (7, 7.4, 10, 11, etc.) inherited from the old single-sidebar Platform layout. With per-section named sidebars, those values pushed overview pages below their sibling categories. Reset every index.md/index.mdx under sources/platform/ to 0 so Section overviews appear first within each sidebar.
Source files referenced /img/platform/integrations/X.svg and the perl substitution that dropped /platform/ from URLs rewrote those to /img/integrations/X.svg. The static files still lived at static/img/platform/integrations/ so the new paths 404'd. Move the 44 icon files to static/img/integrations/ to align.
Master had .yml versions with pre-v3 labels and positions ('AI' at 6
instead of 'AI and LLMs' at 1, 'Workflows & notifications' instead of
'Workflows and notifications', etc.). The v3 commit added .json
versions with current labels but didn't remove the old .yml. Both
existing leaves the source-of-truth ambiguous.
- test.yaml: update header-assertion URLs from /platform/proxy/usage to /actors/proxy/usage to match the new IA paths. - apify-docs-theme/src/theme/SearchBar/index.js: oxfmt formatting (operators trailing rather than leading) after the v3 nav-paths edit. - sources/platform/account/security.md: replace hard tabs with 2-space indentation in nested lists. Pre-existing issue on master, surfaced now because the file moved (path counted as changed in CI). - sources/platform/integrations/programming/webhooks/actions.md: re-pad the eventType/eventData rows so trailing pipes align with the rest of the table. The /platform-prefix drop shortened those URLs by 9 characters and broke MD060 alignment.
TC-MO
changed the title
Contributor
|
✅ Preview for this PR (commit |
Move primary navigation below the logo on its own full-width row. Top row holds the logo and utilities (search, Ask AI, Discord, Console CTA); nav row holds product items on the left and APIs & SDKs on the right. Open source moves out of the navbar into a dedicated footer column. Mobile collapses to a single row (hamburger).
Move /account/limits and /account/security up to /limits and /security and add nav items for them on the product side of the top nav. Remove the corresponding cards from the Account hub.
Reconciled 50 commits of master against the v3 IA preview. Bucketed resolution: - Theme/navbar/docusaurus.config/src: kept v3 (ours) - these ARE the preview - Content + CI workflows: took master's updates (theirs) - Master's new content (agent-onboarding.md, github.md rewrite, AI agents card) had /platform/ links stripped to match the v3 invariant - Renamed image dirs kept at v3 paths; sources/platform/index.mdx stays deleted - Dropped the dummy "trigger CI" commit during cleanup
Reconciled 31 commits of master onto v3 IA preview. - Theme/navbar/config: kept v3 (ours) - Content + workflows: took master's updates - 2FA: accepted master's deletion of legacy console screenshots and the simplified topic; new two-factor-authentication.svg landed at /account/images/ - Integrations: removed Airtable console integration (master), kept v3 paths; new strands.svg moved to /img/integrations/ - store.md → store/index.md (master split into a directory with reviews.mdx); relative links updated for the new depth - continuous_integration.md: simplified per master, link points to v3 /integrations/github
Reconciled 21 new commits of master, including airtable docs rewrite (folder → single file), updated quickstart, master's monetize prose simplification, and CI workflow changes. - Theme/navbar/config: kept v3 (ours) - Content + workflows: took master's updates - Airtable: accepted master's deletion of airtable/index.md; new single-file airtable.md from master is the authoritative version - actor_standby.md: took master's tip-title rewording with v3 link - integrations/actors/index.md: took master's simplified prose and integration_setup_screen image; stripped /platform/ links - integrations/actors/integration_ready_actors.md: same pattern - monetize/index.mdx: kept the auto-merged content from master, stripped /platform/ from the 5 new internal links
Move storage and proxy out of /actors/ to top-level /storage and /proxy. Storage and Proxy are standalone products and shouldn't imply they're nested inside Actors. Update slugs, sidebars, navbar order, and sweep cross-references across the docs. Final nav order: Get started · Actors · Storage · Proxy · Account · Integrations · Limits · Security.
Get Started was duplicating the docs homepage as a 4-card "section index" and providing no orientation. Rewrite the Overview as opinionated onboarding: concept primer (what's an Actor) + first-run path + build paths + next steps. No card grid. Flatten the build-an-actor subsection — only one sub-section under Get Started doesn't justify a category wrapper, and hiding 4 of 5 items behind an unfurl is the opposite of what an onboarding hub should do. Move start_locally → locally, start_web_ide → web-ide, build_with_ai, develop_ai_agents up to /get-started/. Content claims verified against canonical sources in /actors hub and type pages (no fabricated "two minutes" claims, no broken-walkthrough links).
Three cards on the docs root pointed at URLs that no longer exist in v3 (Schedules, Monitoring at top-level; Collaboration at top-level). Repoint them at their nested v3 locations under /actors/running/ and /account/.
/storage was a thin 3-card landing duplicating /storage/usage. Fold
the substantive content from usage.md into the hub: Access methods,
Cost estimator, Rate limiting, Data retention, Named/unnamed,
Sharing, Concurrent access, Delete.
Reorder for logical flow: Access → Named/unnamed (concept) → Data
retention (depends on it) → Costs → Rate limiting → Share → Concurrent
access → Delete. Merge "Preserve your storages" into Named/unnamed.
Split "Share storages between runs" into its own H2 "Concurrent
access" (preserved anchor via {#share-storages-between-runs}).
Add overview images to each storage type page (dataset, key-value
store, request queue). Convert 13 blockquote-as-admonition patterns
across the type pages to proper :::admonitions. Remove description-
repeating bold leads on type pages. Sweep cross-references from
/storage/usage to /storage.
Same pattern as Storage merge. Fold the substantive content from proxy/usage.md into the hub: Connection settings, Username parameters, IP rotation, Sessions, Proxy groups, Proxy IPs, Troubleshooting. Reorder to parallel the Storage hub shape: intro → Proxy types (cards) → Quickstart (code + cross-links to deeper examples) → Connection settings → ... Promote Username parameters from H3 to H2 since it's widely cross-referenced. Tighten the choppy 3-paragraph intro down to 2. Convert 9 blockquote-as-admonition patterns across the proxy type pages to proper :::admonitions. Remove description-repeating bold leads and the orphaned `---` HR after them. Sweep cross-references from /proxy/usage to /proxy.
Old pattern across many pages: a bolded paragraph just after the
frontmatter that repeats (or paraphrases) the frontmatter description,
sometimes followed by an HR separator. Strip 13 instances across
actors/ and integrations/ — leaving the description in frontmatter as
the single source of truth.
Pages cleaned: actors/index, actors/running/index,
actors/development/automated_tests, builds_and_runs/state_persistence,
deployment/continuous_integration, programming_interface/{basic_commands,
container_web_server, metamorph, status_messages, system_events},
integrations/actors/integrating_actors_via_api,
integrations/programming/webhooks/ad_hoc_webhooks,
integrations/workflows-and-notifications/dify.
Match the shape of the Storage and Proxy hubs after their merges: intro paragraph → ## X (cards wrapper) → detail sections. Add `sidebar_label: Overview` so the first sidebar item reads "Overview" like other section hubs. Drop two stub H2s (## Build Actors, ## Run Actors) — each was a single paragraph restating what the cards above already said. Their useful content (how to run, scheduling, etc.) folds into the new intro paragraph. Fix the stale /actors/running/store/index.md link to use the canonical slug /actors/running/actors-in-store.
The /account/store page was a thin (21-line) summary that ended with "For more information, see Actors in Store" — i.e., the page was admitting its own redundancy. The canonical Actors-in-Store page covers pricing models, the run experience, and monetization in 128 lines. Apify Store is also semantically not an Account concern; it lived in /account/ as historical baggage from when Console was a top-level section. Delete the page. Update two cross-references: - pay_per_event.mdx's competitive-comparison link points at the Store landing (apify.com/store) since the context is about market pricing, not docs about the Store. - account/console.md's keyboard-shortcut row points at the canonical /actors/running/actors-in-store docs. The legacy master URL /platform/console/store gets a soft-landing redirect in the flip plan (specific pre-rule before the console wildcard).
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.
(Develop, Run and manage, Publish and monetize, AI and LLMs, etc.)