Add KB support articles: gaps and troubleshooting content not covered…#2639
Draft
anastasiaguspan wants to merge 10 commits into
Draft
Add KB support articles: gaps and troubleshooting content not covered…#2639anastasiaguspan wants to merge 10 commits into
anastasiaguspan wants to merge 10 commits into
Conversation
Contributor
Knowledgebase navigation update
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links✨ Added (31 total)📄 Pages (31)
📝 Changed (28 total)📄 Pages (27)
⚙️ Other (1)
🗑️ 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-kb-refresh.mintlify.app |
Register new support tag pages in docs.json, add missing knowledgebase-nav keywords, retag inference 4xx articles under Server Errors, and add see-also links on priority gap articles. Co-authored-by: Cursor <cursoragent@cursor.com>
mdlinville
approved these changes
May 28, 2026
Contributor
There was a problem hiding this comment.
Support KB review (Matt)
-
Reviewed all 24 new articles + 1 edit on this branch (pragmatic pass: deep review on 9 priority articles, light pass on the rest).
-
First pass content updates:
docs.json: Registered 7 new Models tag pages in the Support tab and hiddenSupport: W&B Modelstab (api,api-keys,authentication,org-management,sdk,teams,workspace).scripts/knowledgebase-nav/config.yaml: Added the 7 keywords CI warned about (clears generator warnings).- Console log pair: Strong and ticket-aligned (
console_multipartleading). Added see-also links to Console logs and Settings reference. Follow-up: consider updatingmodels/app/console-logs.mdxwith multipart (product doc still behind support KB). - Inference 422/404: Retagged from
Authentication & AccesstoServer Errors(these are not auth errors). - API key / slow init / NLP / JAX: Added see-also links to main docs.
- Delete team (edit): Removed warning emoji per style guide.
- Add see-also links on
wandb.watch, parallel coordinates, alerts (point to panel docs / automations). - Style edits, active voice, formatting adjustments, etc etc etc.
-
Second pass to de-duplicate content between KBase articles and main docs: Where primary content existed in a KBase article, moved it to a better main article, with cross-linking between the two.
- Align models/app/console-logs.mdx with support KB coverage of console_multipart so customers see configuration on the product page, not only in support articles. Strip trailing slashes on related internal links in the console KB pair. - Point console log settings to SDK reference instead of duplicating parameters. Keep a short intro and example on the product page; defer full wandb.Settings details to the generated Settings reference. Co-authored-by: Cursor <cursoragent@cursor.com>
- Trim high-overlap articles to point at canonical product and reference pages; add API key format to wandb-login; cross-link KB-unique articles. Net reduction in duplicated procedural content (~240 lines). - Apply support copy style: menu paths use >, bold for UI labels only. Italicize emphasis in prose Reserve bold for UI labels - Remove opinionated tone (avoid simply, easy, all you need) - Scrub for deployment types (dedicated -> Dedicated Cloud, cloud -> Multi-tenant Cloud, self-hosted -> Self-Managed - Rename an article and add a redirect - Copyedits - Regenerate affected tag page cards via knowledgebase-nav.
Resolve conflicts in docs.json and models/app/console-logs.mdx: keep the W&B Launch tab label from main, kb_refresh support nav and Self-Managed redirects, and a combined console-logs Settings intro. Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Support OKR
Draft articles.
69 articles created from the last year of zendesk support tickets for customer support tickets based on recurring issues and time-to-resolve.
Many, especially for Weave, ended up being fundamental docs questioned that have since been answered in created, dedicated docs pages. and we don't want to maintain a source of truth in two places for a lot of these topics.
So, that set was then diffed with existing docs content, leaving 24 articles that are actually a gap in our docs or a partial gap in our docs.
the following are highest priority as FULL GAP
api-error-code-422-invalid-request-parameters
how-do-i-download-the-console-log-file-from-a-run
how-do-i-log-nlp-metrics-and-text-outputs-in-wandb
how-do-i-use-wandb-with-jax
i-deleted-my-team-and-now-i-cant-create-a-new-one
why-does-my-api-key-fail-with-must-be-40-characters
why-is-my-wandb-run-slow-to-initialize-or-upload
the rest are considered partial gap to our covered docs content.