Skip to content

docs:diataxis-first-pass#24

Open
wardbryan3 wants to merge 8 commits into
mainfrom
docs-diataxis-framewrok
Open

docs:diataxis-first-pass#24
wardbryan3 wants to merge 8 commits into
mainfrom
docs-diataxis-framewrok

Conversation

@wardbryan3
Copy link
Copy Markdown
Collaborator

Diataxis first pass

wardbryan3 and others added 8 commits June 1, 2026 18:24
- Sidebar now follows Diataxis: Tutorial > How-to guides > Explanation > Reference
- Features nested inside each Diataxis type (no Platform wrapper)
- Moved files out of docs/platform/ to top-level feature dirs
  (clusters/, jobs/, workbench/, storage/, licenses/, teams/)
- Moved compute-providers and iam under settings/
- Moved cli/sdk/api under developer-tools/
- Moved concepts under explanation/concepts/
- Created new content: compute profiles how-to, template workflow,
  account settings, license inventory, subscription management,
  slurm-vs-kubernetes, why-teams-and-iam, workbench-ml-stack
- Rewrote SDK and API reference indexes (removed marketing language)
- Fixed 404 landing pages (training, services, pools)
- Updated all internal links to match new paths
- autoCollapseCategories: true in docusaurus config
- All sidebar trees collapsed by default

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… guides

Merge the 7 individual getting-started pages into one guided tutorial
walkthrough. Move all feature-level get-started and tutorial pages into
the How-to guides section. Add 13 new how-to guides covering pipelines,
sweeps, session management, Cloud Shell, Remote Desktop, PVC Viewer,
observability, job catalog, storage mounting, and cloud account management.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add Cloud Accounts as top-level how-to category above Clusters
- Add cluster how-tos: configure partitions, manage compute pools,
  manage a cluster, Slurm on Kubernetes
- Add cloud account how-tos: AWS, Azure, GCP, LXD/On-Premises
- Add IAM how-tos: generate API keys, set up SSO
- Add Workbench how-tos: create compute pool, manage services,
  configure training runtime, create training preset
- Add developer tools how-tos: REST API auth, first API call,
  SDK configure and use
- Add storage how-tos: mount in training jobs, mount in endpoints
- Rename IAM sidebar category to Users & Permissions
- Rename tutorial pages to task-oriented walkthrough titles
- Extract SSO content from account-settings into dedicated page
- Add early-access warning to Pipelines creating page
- Add Related sections to federation walkthroughs
- Restructure Workbench into Develop/Compute/Train/Serve sub-groups

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant