fix: relocate Automations snippet includes and fix localized imports#2727
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links🔄 Renamed/Moved (31 total)📄 Pages (31)
✨ Added (1 total)📄 Pages (1)
📝 Changed (16 total)📄 Pages (16)
🗑️ Deleted (1 total)View deleted files📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-style-guide-snippets-en-20260604-115945.mintlify.app |
mdlinville
approved these changes
Jun 4, 2026
mdlinville
left a comment
mdlinville
left a comment
Contributor
There was a problem hiding this comment.
First, I pushed a commit into this PR to fix some snippet localization mistakes that predate the PR.
Next, this is a partial review, with some specific nits and some "off" patterns that I'm seeing in the edit that could be improved. Approving optimistically so you aren't blocked but let me know if you want me to keep going or look again.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes and restyles Automations tutorial snippet includes (including adding localized snippet variants) and performs a broad style/wording pass across multiple Sweeps documentation pages, including new frontmatter metadata (keywords) and copy edits.
Changes:
- Moved Automations include snippets from
snippets/en/_includes/...to sharedsnippets/_includes/...and updated Automations pages to import the new paths. - Added localized Automations snippet includes for
ko,ja, andfr, and updated localized Automations pages to import locale-specific includes. - Updated a large set of Sweeps docs with rewritten intros/structure, keyword metadata, and refined wording/examples.
Reviewed changes
Copilot reviewed 36 out of 63 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| snippets/ko/_includes/automations/where-to-find-automations.mdx | Adds Korean “where to find automations” include snippet. |
| snippets/ko/_includes/automations/tutorial-notebook.mdx | Adds Korean tutorial notebook include (currently commented out). |
| snippets/ko/_includes/automations/tutorial-go-further.mdx | Adds Korean “go further” include snippet (with commented API links). |
| snippets/ko/_includes/automations/tutorial-diagram-registry.mdx | Adds Korean registry diagram include snippet. |
| snippets/ko/_includes/automations/tutorial-diagram-project.mdx | Adds Korean project diagram include snippet. |
| snippets/ko/_includes/automations/mental-model.mdx | Adds Korean mental model include snippet. |
| snippets/ko/_includes/automations/best-practices.mdx | Adds Korean best practices include snippet. |
| snippets/ko/_includes/automations/actions-list.mdx | Adds Korean actions list include snippet. |
| snippets/ja/_includes/automations/where-to-find-automations.mdx | Adds Japanese “where to find automations” include snippet. |
| snippets/ja/_includes/automations/tutorial-notebook.mdx | Adds Japanese tutorial notebook include (currently commented out). |
| snippets/ja/_includes/automations/tutorial-go-further.mdx | Adds Japanese “go further” include snippet (with commented API links). |
| snippets/ja/_includes/automations/tutorial-diagram-registry.mdx | Adds Japanese registry diagram include snippet. |
| snippets/ja/_includes/automations/tutorial-diagram-project.mdx | Adds Japanese project diagram include snippet. |
| snippets/ja/_includes/automations/mental-model.mdx | Adds Japanese mental model include snippet. |
| snippets/ja/_includes/automations/best-practices.mdx | Adds Japanese best practices include snippet. |
| snippets/ja/_includes/automations/actions-list.mdx | Adds Japanese actions list include snippet. |
| snippets/fr/_includes/automations/where-to-find-automations.mdx | Adds French “where to find automations” include snippet. |
| snippets/fr/_includes/automations/tutorial-notebook.mdx | Adds French tutorial notebook include (currently commented out). |
| snippets/fr/_includes/automations/tutorial-go-further.mdx | Adds French “go further” include snippet (with commented API links). |
| snippets/fr/_includes/automations/tutorial-diagram-registry.mdx | Adds French registry diagram include snippet. |
| snippets/fr/_includes/automations/tutorial-diagram-project.mdx | Adds French project diagram include snippet. |
| snippets/fr/_includes/automations/mental-model.mdx | Adds French mental model include snippet. |
| snippets/fr/_includes/automations/best-practices.mdx | Adds French best practices include snippet. |
| snippets/fr/_includes/automations/actions-list.mdx | Adds French actions list include snippet. |
| snippets/en/_includes/automations/where-to-find-automations.mdx | Removes the English include in favor of shared includes. |
| snippets/_includes/automations/where-to-find-automations.mdx | Introduces shared “where to find automations” include snippet. |
| snippets/_includes/automations/tutorial-notebook.mdx | Introduces shared tutorial notebook include (currently commented out). |
| snippets/_includes/automations/tutorial-go-further.mdx | Tweaks shared “go further” include wording/structure. |
| snippets/_includes/automations/tutorial-diagram-registry.mdx | Introduces shared registry diagram include snippet. |
| snippets/_includes/automations/tutorial-diagram-project.mdx | Introduces shared project diagram include snippet. |
| snippets/_includes/automations/mental-model.mdx | Adjusts shared mental model include wording. |
| snippets/_includes/automations/best-practices.mdx | Adjusts shared best practices include wording. |
| snippets/_includes/automations/actions-list.mdx | Adjusts shared actions list include wording. |
| models/sweeps/walkthrough.mdx | Sweeps walkthrough copy rewrite + keywords frontmatter. |
| models/sweeps/visualize-sweep-results.mdx | Sweeps visualization doc restructure + keywords frontmatter. |
| models/sweeps/useful-resources.mdx | Sweeps resources doc restructure + keywords frontmatter. |
| models/sweeps/troubleshoot-sweeps.mdx | Sweeps troubleshooting copy rewrite + keywords frontmatter. |
| models/sweeps/sweep-config-keys.mdx | Sweep config reference wording updates + keywords frontmatter. |
| models/sweeps/start-sweep-agents.mdx | Sweep agent start guide rewrite + keywords frontmatter. |
| models/sweeps/signal-handling-sweep-runs.mdx | Signal handling guide expanded/rewritten + keywords frontmatter. |
| models/sweeps/pause-resume-and-cancel-sweeps.mdx | Sweep lifecycle CLI guide expanded + keywords frontmatter. |
| models/sweeps/parallelize-agents.mdx | Parallelization guide rewrite + keywords frontmatter. |
| models/sweeps/local-controller.mdx | Local controller guide rewrite + keywords frontmatter. |
| models/sweeps/initialize-sweeps.mdx | Initialization guide rewrite + keywords frontmatter. |
| models/sweeps/existing-project.mdx | Existing-project tutorial rewrite + keywords frontmatter. |
| models/sweeps/define-sweep-configuration.mdx | Sweep configuration overview expanded + keywords frontmatter. |
| models/sweeps/add-w-and-b-to-your-code.mdx | Integration guide expanded + keywords frontmatter. |
| models/automations/tutorial.mdx | Updates imports to shared Automations snippets. |
| models/automations/registry-automation-tutorial.mdx | Updates imports to shared Automations snippets. |
| models/automations/project-automation-tutorial.mdx | Updates imports to shared Automations snippets. |
| models/automations.mdx | Updates imports to shared Automations snippets. |
| ko/models/automations/tutorial.mdx | Switches imports to Korean Automations snippets. |
| ko/models/automations/registry-automation-tutorial.mdx | Switches imports to Korean Automations snippets. |
| ko/models/automations/project-automation-tutorial.mdx | Switches imports to Korean Automations snippets. |
| ko/models/automations.mdx | Switches imports to Korean Automations snippets. |
| ja/models/automations/tutorial.mdx | Switches imports to Japanese Automations snippets. |
| ja/models/automations/registry-automation-tutorial.mdx | Switches imports to Japanese Automations snippets. |
| ja/models/automations/project-automation-tutorial.mdx | Switches imports to Japanese Automations snippets. |
| ja/models/automations.mdx | Switches imports to Japanese Automations snippets. |
| fr/models/automations/tutorial.mdx | Switches imports to French Automations snippets. |
| fr/models/automations/registry-automation-tutorial.mdx | Switches imports to French Automations snippets. |
| fr/models/automations/project-automation-tutorial.mdx | Switches imports to French Automations snippets. |
| fr/models/automations.mdx | Switches imports to French Automations snippets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Apply all inline review feedback from @mdlinville on PR #2727: - Apply suggested wording fixes (define-sweep-configuration examples intro, Bayes/Hyperband intro, initialize-sweeps warning, start-sweep-agents prerequisites and intro, pause-resume intro). - Restructure the CLI tab in add-w-and-b-to-your-code into a numbered procedure with indented code blocks; same for the multi-CPU/multi-GPU steps in parallelize-agents (replace bold "Terminal 1/2" labels with list items). - Fix terminology: "a W&B sweep" -> "a sweep" (W&B Sweeps is the product; a sweep is the artifact it manages). - Remove redundant link-text phrasing ("For more information about how to X, see [X]") flagged as a recurring pattern. - Convert relative links to absolute and drop trailing slashes from internal links (avoids Mintlify redirects). - Reword the local-controller intro; move SDK install into a Prerequisites section. - Drop the placeholder Note and the redundant "three nested parameters" count; reword the nested-config Warning. - Remove the shadow-reference flag bullet list in pause-resume; the per-command sections and the CLI reference cover it. - Strip trailing whitespace in define-sweep-configuration and add a blank line after a fenced block to fix diff rendering. - Fix a broken cross-reference anchor to add-w-and-b-to-your-code#python-script-or-notebook. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Address Copilot review findings on PR #2727: - troubleshoot-sweeps: fix Python guard `if _name_ == "_main_"` -> `if __name__ == "__main__"` (single underscores would fail if copied). - define-sweep-configuration: fix template top-level key `parameter:` -> `parameters:` (the singular form produces an invalid sweep config). - sweep-config-keys: fix `parameter` -> `parameters` key references, and correct "specify the distribution ... with the metric key" to point to the `parameters` key where distributions are actually defined. - local-controller: the final step ran `wandb sweep [SWEEP-ID]` (re-inits the sweep) -> `wandb agent [SWEEP-ID]` to start an agent; reword the preceding sentence to start agents rather than "start a sweep". - useful-resources: fix corrupted section header "selfm-anaged" -> "How-to guide". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
johndmulhausen
changed the title
johndmulhausen
added a commit
that referenced
this pull request
Jun 5, 2026
Apply all inline review feedback from @mdlinville on PR #2727: - Apply suggested wording fixes (define-sweep-configuration examples intro, Bayes/Hyperband intro, initialize-sweeps warning, start-sweep-agents prerequisites and intro, pause-resume intro). - Restructure the CLI tab in add-w-and-b-to-your-code into a numbered procedure with indented code blocks; same for the multi-CPU/multi-GPU steps in parallelize-agents (replace bold "Terminal 1/2" labels with list items). - Fix terminology: "a W&B sweep" -> "a sweep" (W&B Sweeps is the product; a sweep is the artifact it manages). - Remove redundant link-text phrasing ("For more information about how to X, see [X]") flagged as a recurring pattern. - Convert relative links to absolute and drop trailing slashes from internal links (avoids Mintlify redirects). - Reword the local-controller intro; move SDK install into a Prerequisites section. - Drop the placeholder Note and the redundant "three nested parameters" count; reword the nested-config Warning. - Remove the shadow-reference flag bullet list in pause-resume; the per-command sections and the CLI reference cover it. - Strip trailing whitespace in define-sweep-configuration and add a blank line after a fenced block to fix diff rendering. - Fix a broken cross-reference anchor to add-w-and-b-to-your-code#python-script-or-notebook. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
johndmulhausen
added a commit
that referenced
this pull request
Jun 5, 2026
Address Copilot review findings on PR #2727: - troubleshoot-sweeps: fix Python guard `if _name_ == "_main_"` -> `if __name__ == "__main__"` (single underscores would fail if copied). - define-sweep-configuration: fix template top-level key `parameter:` -> `parameters:` (the singular form produces an invalid sweep config). - sweep-config-keys: fix `parameter` -> `parameters` key references, and correct "specify the distribution ... with the metric key" to point to the `parameters` key where distributions are actually defined. - local-controller: the final step ran `wandb sweep [SWEEP-ID]` (re-inits the sweep) -> `wandb agent [SWEEP-ID]` to start an agent; reword the preceding sentence to start agents rather than "start a sweep". - useful-resources: fix corrupted section header "selfm-anaged" -> "How-to guide". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The models/sweeps style-guide pass was duplicated here; it belongs in its dedicated PR (#2722), which now carries the full sweeps changes plus all review fixes from @mdlinville and Copilot. Restore the sweeps files to their pre-PR state so this PR is scoped to the snippets/automations pass (and @mdlinville's localized-snippet path fixes) only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
johndmulhausen
changed the title
johndmulhausen
changed the title
Contributor
Author
|
@mdlinville thanks for the partial review — and especially for pushing the localization fix, which predated this PR and would've bitten us. The PR has changed shape since you looked, which makes your "want me to keep going?" easy to answer: I've re-scoped #2727 down to just the Automations snippet reorg + localization — relocating the shared includes to All the So nothing left to chase on sweeps here. #2722 is the place for the sweeps re-review if you want to take another look there. |
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
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.
Note
A
models/sweepsstyle pass was briefly bundled into this PR by mistake. It now lives in its dedicated PR #2722, which carries all of @mdlinville's and Copilot's review fixes. This PR no longer touchesmodels/sweeps.Summary
Three related changes to the Automations docs. The bulk is a structural reorganization of the snippet includes plus a real localization bug fix; a small
/style-guidecopy pass on five English snippets rides along. No technical content was rewritten.If you reviewed an earlier version of this PR and expected edits under
snippets/en/_includes/automations/, note that those files were relocated (see change 1 below) — the edits are intact, just at a new path.What changed
1. Relocated the shared (English) includes —
snippets/en/_includes/automations/→snippets/_includes/automations/(8 files)Language-neutral includes now live at the shared snippets root. The English pages under
models/automations*import from the new path.2. Fixed the localized includes and their imports (the main bug fix)
fr/ja/koincludes were nested under a malformed path with a strayen/segment:snippets/{fr,ja,ko}/en/_includes/automations/. Moved them tosnippets/{fr,ja,ko}/_includes/automations/(24 files).{fr,ja,ko}/models/automations*) were importing the English snippet path (/snippets/en/_includes/...), so French/Japanese/Korean pages rendered English snippet text. Each locale's pages now import its own locale's snippets (/snippets/fr/_includes/..., etc.).3.
/style-guidecopy pass on five English snippets (Google Developer Style Guide + CoreWeave conventions; wording only)snippets/_includes/automations/)actions-list.mdxlikesuch as CI/CD pipelines…"best-practices.mdxRoute different severities to different channels if needed." → "If you have multiple severities, route them to different channels."mental-model.mdxa simplethis pattern"tutorial-go-further.mdxwhere-to-find-automations.mdxclickselect the Automations tab" (×2)File inventory (48 files)
snippets/_includes/automations/(5 carry the style edits above;tutorial-diagram-project,tutorial-diagram-registry, andtutorial-notebookmoved unchanged).snippets/{fr,ja,ko}/_includes/automations/(content unchanged; path fix only).models/automations.mdx+models/automations/{project-automation-tutorial,registry-automation-tutorial,tutorial}.mdx, and thefr/ja/koequivalents.Review checklist
import … from "/snippets/_includes/automations/…"paths resolve.fr/ja/koAutomations pages now render localized snippet text, not English.Style-edit review notes
Carried over from the original style pass; still worth a glance:
actions-list.mdx— Confirm "Call a webhook URL with a JSON payload" matches the implementation (some W&B docs phrase this as a POST to a configured endpoint). Confirm the Slack-notification link target (run/artifact/workspace) is intentionally abstract for a reused include. Confirm no action types are missing (for example, job-triggering actions).best-practices.mdx— Confirm the tightened severity-routing wording matches author intent. "alias patterns" is mentioned without a link to where aliases are defined; consider linking on first use.mental-model.mdx— The closing sentence links toautomation-events#project,#registry, and the bare page (three links to ~one destination); consider consolidating. Confirm bold-on-first-mention (event, conditions, action) is house style. The Mermaid'rankSpacing': 200;has a stray trailing semicolon inside the config object — verify the diagram renders.tutorial-go-further.mdx— Two API bullets ("Manage automations with the API", "Automations API reference") are commented out pending the Python SDKcreate_automationregression (internal WB-34263); restore them once it's fixed.where-to-find-automations.mdx— Confirm "Automations" is the current tab label in both the project and registry views, and that the tab is reachable from a sidebar in both contexts.