Skip to content

[DOCS-1917] Automations doc revamp#2249

Merged
mdlinville merged 64 commits into
mainfrom
DOCS-1917
May 13, 2026
Merged

[DOCS-1917] Automations doc revamp#2249
mdlinville merged 64 commits into
mainfrom
DOCS-1917

Conversation

@mdlinville
Copy link
Copy Markdown
Contributor

@mdlinville mdlinville commented Mar 6, 2026 •
edited
Loading

Description

Automations doc revamp

  • Update the structure.
  • Split out shared content into snippets
  • Add API instructions, commented out until WB-34263 is fixed in the SDK
  • Incorporate Nina's tutorial draft to create new tutorials
  • Add a Mermaid diagram to the overview

Links to a Python notebook added in wandb/examples#618 are also commented out until WB-32463 is fixed.

Testing

  • Local build succeeds without errors (mint dev)
  • Local link check succeeds without errors (mint broken-links)
  • PR tests succeed

Related issues

@mdlinville mdlinville changed the title Automations doc revamp [WIP] Automations doc revamp Mar 6, 2026
@mdlinville mdlinville marked this pull request as ready for review March 6, 2026 23:28
@mdlinville mdlinville requested a review from a team as a code owner March 6, 2026 23:29
@mdlinville mdlinville requested a review from aninahpets March 6, 2026 23:29
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 6, 2026 •
edited
Loading

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (12 total)

📄 Pages (12)

File Preview
models/automations/api.mdx Api
models/automations/project-automation-tutorial.mdx Project Automation Tutorial
models/automations/registry-automation-tutorial.mdx Registry Automation Tutorial
models/automations/tutorial.mdx Tutorial
snippets/en/_includes/automations/actions-list.mdx Actions List
snippets/en/_includes/automations/best-practices.mdx Best Practices
snippets/en/_includes/automations/mental-model.mdx Mental Model
snippets/en/_includes/automations/tutorial-diagram-project.mdx Tutorial Diagram Project
snippets/en/_includes/automations/tutorial-diagram-registry.mdx Tutorial Diagram Registry
snippets/en/_includes/automations/tutorial-go-further.mdx Tutorial Go Further
... and 2 more files

📝 Changed (6 total)

📄 Pages (5)

File Preview
models/automations.mdx Automations
models/automations/automation-events.mdx Automation Events
models/automations/create-automations.mdx Create Automations
models/automations/create-automations/slack.mdx Slack
models/automations/create-automations/webhook.mdx Webhook
⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 59b3f6b at 2026-05-13 23:36:24 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 6, 2026 •
edited
Loading

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-docs-1917.mintlify.app

@mdlinville
Automations doc revamp
d65bd5f 
- Update the structure
- Add API instructions
- Incorporate Nina's tutorial draft to create a new
  tutorial page split into Project and Registry views
- Add a Python notebook
- Split out shared content into snippets
- Add a Mermaid diagram to the overview

Fixes:
- DOCS-1917
- DOCS-1126
@mdlinville mdlinville mentioned this pull request Mar 9, 2026
Closed
3 tasks
mdlinville
mdlinville commented Mar 10, 2026
View reviewed changes
Comment thread models/automations/create-automations/webhook.mdx Outdated
Comment thread models/automations/api.mdx Outdated
@mdlinville mdlinville mentioned this pull request Mar 10, 2026
Draft
@mdlinville mdlinville changed the title [WIP] Automations doc revamp [DOCS-1917][DOCS-1126] Automations doc revamp Mar 10, 2026
aninahpets
aninahpets approved these changes May 13, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@aninahpets aninahpets left a comment

Choose a reason for hiding this comment

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

LGTM!

@mdlinville mdlinville changed the title [DOCS-1917][DOCS-1126] Automations doc revamp [DOCS-1917] Automations doc revamp May 13, 2026
@mdlinville mdlinville merged commit cbc0a5c into main May 13, 2026
4 checks passed
@mdlinville mdlinville deleted the DOCS-1917 branch May 13, 2026 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aninahpets aninahpets aninahpets approved these changes

@ngrayluna ngrayluna Awaiting requested review from ngrayluna

@johndmulhausen johndmulhausen Awaiting requested review from johndmulhausen

@tonyyli-wandb tonyyli-wandb Awaiting requested review from tonyyli-wandb

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mdlinville @johndmulhausen @ngrayluna @aninahpets