Closed
Conversation
Generated by DocEngine CI (merge to main).
Member
Author
|
Closing, duplicate. |
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.
This PR implements the MDX page updates caused by DocEngine PR 23.
Important
Please review before merging. Do not assume it is safe!
Source PR (DocEngine)
Title: feat: W&B Knowledgebase
Description:
W&B Knowledgebase — Multi-product support site
Replaces the single-page accordion support page with a full multi-product knowledgebase, covering W&B Models, W&B Weave, and W&B Inference. Adds new DocEngine engine capabilities to support data-driven form fields and computed navigation.
Note
Follow-up tasks: After this PR merges, a GitHub action will create a new PR in the
wandb/docsrepo.Before merging that PR, update it with the suggested actions documented here: https://docs.google.com/document/d/1WCCpXnNdpm5CzWjAHqtfC2sVCjsHmRFMeppp45DXxHA/edit?tab=t.0#heading=h.nt0zlq2zufd1
What changed
Knowledgebase site (
sites/wandb-docs)Schema (
knowledgebase.py)priority(int sort order) and single-valueproductfields.products: List[Literal['W&B Models', 'W&B Weave', 'W&B Inference']]— articles can now belong to multiple products.featured: bool— marks articles surfaced on index pages.options_from_datametadata ontagsso the web UI filters available tags based on the selected products.table_max_length,default_sort, better column visibility.Generators
support_page.pysupport_article.pygroupgenerator; emits one article MDX per record per product (support/{slug}/articles/{id}.mdx) and one tag index page per(product, tag)pair (support/{slug}/tags/{tag-slug}.mdx). Also owns the computed navigation declaration.support_index.pysinglegenerator; emitssupport/index.mdxwith featured articles grouped by product.support_product_index.pygroupgenerator; emits one per-product overview page (support/{slug}/index.mdx) with featured articles and a tag-category index, plus a redirect stub page per product that activates the hidden per-product Mintlify tab.navigation_updater.pycomputed, which calls a generator classmethod (build_navigation) at build time and merges the resulting tab structure intodocs.json.Navigation structure (Mintlify)
The computed navigation builder in
SupportArticleGeneratorproduces:Article pages themselves are not in
docs.jsonnavigation — they are reached through tag pages or direct links.Templates
Replaced
support.mdx.j2with four new templates:support_article.mdx.j2— individual article pagesupport_tag.mdx.j2— tag index page with Mintlify Cards linking to articlessupport_index.mdx.j2— global support landing pagesupport_product_index.mdx.j2— per-product overview with tag categoriesData (
data/knowledgebase/)202 records total. All existing records migrated from
product: <single>toproducts: [<list>]. New articles added, including Weave-specific content:long-eval-clean-up-times—client.flush()andWEAVE_CLIENT_PARALLELISMfor large dataset uploadsserver-response-caching—WEAVE_USE_SERVER_CACHEand cache sizingtrace-data-is-truncated— returning dicts from@weave.opto avoid truncationtrace-data-loss-in-worker-processes— worker process tracing patternstrace-pages-load-slowly— performance tips for large tracesos-errors-too-many-open-files— file descriptor limitswhat-is-pairwise-evaluation-and-how-do-i—PreferenceScorerpattern with full code samplewhat-information-does-weave-capture-for— Weave data capture scopewill-weave-affect-my-function-s-executio— execution overheadhow-is-weave-data-ingestion-calculated— billing/ingestion detailshow-do-i-render-markdown-in-the-ui/how-do-i-render-python-datetime-values-i— UI rendering tipshow-can-i-disable-client-information-cap,how-can-i-disable-code-capture,how-can-i-disable-system-information-cap— privacy/telemetry controlsDocEngine engine (
app/)app/core/data_manager.py— newget_unique_values(table, field_name, filter_field, filter_value)method. Returns sorted unique values for a field, optionally filtered by another field with list-overlap semantics. Powers data-driven tag dropdowns in the web UI.app/core/form_generator.py— threadsoptions_from_dataschema metadata through toFormField.validation_rulesso the form renderer can act on it.app/web/components/form_renderer.py— new chip-style tags field (_render_tags_field_chip_style):get_unique_values, filtered by a related field (e.g., tags filtered by selected products).ui.selectwithnew_value_modewhen nooptions_from_datais set.app/web/components/record_editor.py/app/server.py— passdata_managerandtableintoFormRendererso the chip-style field can query live data.Navigation updater — computed declarations
NavigationUpdaterGenerator._collect_declarations()now returns a third list,computed_declarations, for generators that declarenavigation = {'type': 'computed', 'builder': '<classmethod_name>', 'table': '<table>'}. After processing group and single declarations,_apply_computed_navigationcalls the builder with the full data dict, then_apply_tabmerges each resulting tab spec into the livedocs.jsonnav root (finding or creating the tab, settingicon,hidden, andpages).Documentation
Updated
CLAUDE.md,README.md,docs/ARCHITECTURE.md,docs/DEVELOPMENT.md,docs/SCHEMA.md,docs/USER_GUIDE.md, anddocs/generators/navigation_updater.mdto reflect the new schema fields, computed navigation pattern, and chip-style tags field.Workflow run: Run number 9 — View build
Branch:
8bed70e4108f04b0e7e19bc224f3e7f6f8652272— View branchThis PR contains auto-generated updates from DocEngine.
Source:
coreweave/docengine@8bed70e4108f04b0e7e19bc224f3e7f6f8652272Trigger: push | Site:
wandb-docs