Skip to content

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Sep 30, 2025

  • Create 10 numbered directories for new IA
  • Add category.yml for sidebar ordering
  • Add minimal placeholder index files (to be replaced)

Part of Platform IA reorganization

- Create 10 numbered directories for new IA
- Add _category_.yml for sidebar ordering
- Add minimal placeholder index files (to be replaced)

Part of Platform IA reorganization
- Migrate console/ → 2-console/
- Update index front matter (slug: /console)

Part of Platform IA reorganization
- Migrate actors/running → 3-using-actors
- Migrate storage → 4-core-concepts/storage
- Migrate proxy → 4-core-concepts/proxy
- Migrate actors/development → 5-building-actors
- Migrate actors/publishing → 6-publishing-and-monetization
- Update all front matter slugs
- Add nginx redirects for all moved paths

Part of Platform IA reorganization
…n only)

- Migrate integrations → 7-integrations
- Migrate collaboration → 8-collaboration
- Migrate monitoring → 9-monitoring-and-operations/monitoring
- Update all front matter slugs
- Add nginx redirects
- All 10 sections now complete

Part of Platform IA reorganization
…ete)

- Remove old directory structure (actors/, storage/, proxy/, etc.)
- Update internal links to new paths
- All content now in numbered sections (1-10)

Ready for deployment.
Content placement adjustments
Link fixes
nginx.conf adjustments
- Updated all CardGrid component links across platform documentation to
use proper slugs
- Fixed relative links (./integrations/...) to absolute paths
(/platform/integrations/...)
- Corrected storage links from /platform/storage/... to
/platform/core-concepts/storage/...
- Corrected proxy links from /platform/proxy/... to
/platform/core-concepts/proxy/...
- Fixed building-actors links from /platform/actors/development/... to
/platform/building-actors/...
- Fixed incorrect targets (e.g., Environment variables, Status events)
@TC-MO TC-MO self-assigned this Sep 30, 2025
@TC-MO TC-MO added the documentation Improvements or additions to documentation. label Sep 30, 2025
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Sep 30, 2025
merge proxy & storage indexes into one core concepts index
@TC-MO TC-MO changed the title feat(platform): Phase 1 - Foundation structure (reorganization only) feat(platform): IA rework Sep 30, 2025
@TC-MO
Copy link
Contributor Author

TC-MO commented Sep 30, 2025

I wanted to create a preview so people could click through the proposed changes for IA, and we could have a starting point to start discussions and colalborate on it, but then I got stuck in a constant loop of:

  1. Fix links
  2. Wake up Vale with new issues

ad nausem.

I might try to split this PR into some more manageable chunks instead of this monstrosity, but I'll leave this as draft for nwo as reference. Apart from that best I can do is I guess add screenshot of how the new IA looks, and then maybe you can infer something from the changed files (tho it is overwhelming since I was moving all the files around)

@TC-MO
Copy link
Contributor Author

TC-MO commented Sep 30, 2025

The idea behind this IA is to try and address few issues at the same time.

  1. Make Getting started/Quick start much more prominent to guide users there if they want an absolute TL:DR on creating their first Actor.
  2. Split docs for:
    • Actor users - thus Console docs & whole Using Actors section where we explain concepts like
      • Store
      • Inputs & outputs
      • Runs and builds
      • Usage and resources
      • etc.
    • Actor builders (develoeprs)
      • Docs where we explain more technical aspects like
        • What does Actors consist of
        • actor.json
        • Input. Dataset & KV store schema (and in the future Output schema)
        • Deployment
        • etc.
      • Publishing & monetization

The rest of docs stays as is current.

So this would be what would greet users. Getting started is deliberately by default uncollapsed so users can see everything. (might change the name to Quick start)

image

Console section
image

Using Actors
image

Core concepts (not completely sold on this name, or this division for that matter)
image

Building Actors section
image
image

Publishing & monetization
image

Integrations - as currently

Collaboration - as currently

@TC-MO TC-MO closed this Oct 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant