Skip to content

docs: Update from DocEngine PR 23#2280

Closed
dfinster wants to merge 1 commit intomainfrom
doceng/wandb-docs-23051587561
Closed

docs: Update from DocEngine PR 23#2280
dfinster wants to merge 1 commit intomainfrom
doceng/wandb-docs-23051587561

Conversation

@dfinster
Copy link
Member

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/docs repo.

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)

  • Removed priority (int sort order) and single-value product fields.
  • Added products: List[Literal['W&B Models', 'W&B Weave', 'W&B Inference']] — articles can now belong to multiple products.
  • Added featured: bool — marks articles surfaced on index pages.
  • Added options_from_data metadata on tags so the web UI filters available tags based on the selected products.
  • Improved table metadata: table_max_length, default_sort, better column visibility.

Generators

File Change
support_page.py Deleted — replaced by the three generators below
support_article.py Newgroup generator; 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.py Newsingle generator; emits support/index.mdx with featured articles grouped by product.
support_product_index.py Newgroup generator; 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.py Updated — adds support for a third declaration type, computed, which calls a generator classmethod (build_navigation) at build time and merges the resulting tab structure into docs.json.

Navigation structure (Mintlify)

The computed navigation builder in SupportArticleGenerator produces:

  • A visible Support tab containing the global landing page and per-product redirect stubs.
  • One hidden Support: {Product} tab per product, containing that product's overview and tag index pages.

Article pages themselves are not in docs.json navigation — they are reached through tag pages or direct links.

Templates

Replaced support.mdx.j2 with four new templates:

  • support_article.mdx.j2 — individual article page
  • support_tag.mdx.j2 — tag index page with Mintlify Cards linking to articles
  • support_index.mdx.j2 — global support landing page
  • support_product_index.mdx.j2 — per-product overview with tag categories

Data (data/knowledgebase/)

202 records total. All existing records migrated from product: <single> to products: [<list>]. New articles added, including Weave-specific content:

  • long-eval-clean-up-timesclient.flush() and WEAVE_CLIENT_PARALLELISM for large dataset uploads
  • server-response-cachingWEAVE_USE_SERVER_CACHE and cache sizing
  • trace-data-is-truncated — returning dicts from @weave.op to avoid truncation
  • trace-data-loss-in-worker-processes — worker process tracing patterns
  • trace-pages-load-slowly — performance tips for large traces
  • os-errors-too-many-open-files — file descriptor limits
  • what-is-pairwise-evaluation-and-how-do-iPreferenceScorer pattern with full code sample
  • what-information-does-weave-capture-for — Weave data capture scope
  • will-weave-affect-my-function-s-executio — execution overhead
  • how-is-weave-data-ingestion-calculated — billing/ingestion details
  • how-do-i-render-markdown-in-the-ui / how-do-i-render-python-datetime-values-i — UI rendering tips
  • how-can-i-disable-client-information-cap, how-can-i-disable-code-capture, how-can-i-disable-system-information-cap — privacy/telemetry controls
  • W&B Inference API error code articles (401, 402, 403 × 2, 429, 500, 503)

DocEngine engine (app/)

app/core/data_manager.py — new get_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 — threads options_from_data schema metadata through to FormField.validation_rules so the form renderer can act on it.

app/web/components/form_renderer.py — new chip-style tags field (_render_tags_field_chip_style):

  • Shows current values as removable chips.
  • Dropdown populated from live data via get_unique_values, filtered by a related field (e.g., tags filtered by selected products).
  • "Add new tag" text input for values not yet in the dataset.
  • Cascading refresh: changing the filter field (e.g., products) immediately re-populates the tags dropdown.
  • Falls back to the legacy ui.select with new_value_mode when no options_from_data is set.

app/web/components/record_editor.py / app/server.py — pass data_manager and table into FormRenderer so 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 declare navigation = {'type': 'computed', 'builder': '<classmethod_name>', 'table': '<table>'}. After processing group and single declarations, _apply_computed_navigation calls the builder with the full data dict, then _apply_tab merges each resulting tab spec into the live docs.json nav root (finding or creating the tab, setting icon, hidden, and pages).


Documentation

Updated CLAUDE.md, README.md, docs/ARCHITECTURE.md, docs/DEVELOPMENT.md, docs/SCHEMA.md, docs/USER_GUIDE.md, and docs/generators/navigation_updater.md to reflect the new schema fields, computed navigation pattern, and chip-style tags field.


Workflow run: Run number 9 — View build
Branch: 8bed70e4108f04b0e7e19bc224f3e7f6f8652272View branch

This PR contains auto-generated updates from DocEngine.

Source: coreweave/docengine @ 8bed70e4108f04b0e7e19bc224f3e7f6f8652272
Trigger: push | Site: wandb-docs

Generated by DocEngine CI (merge to main).
@dfinster dfinster requested a review from a team as a code owner March 13, 2026 12:50
@dfinster
Copy link
Member Author

Closing, duplicate.

@dfinster dfinster closed this Mar 13, 2026
@dfinster dfinster deleted the doceng/wandb-docs-23051587561 branch March 13, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant