[DO NOT MERGE] Manual check#183
Closed
ngrayluna wants to merge 1 commit into
Closed
Conversation
dfinster
added a commit
that referenced
this pull request
Jun 23, 2026
> **Draft — depends on coreweave/docengine#183.** Do not merge until #183 is merged and this repo's `docengine` submodule is bumped to include it (Dependabot bump). The workflow calls `docengine knowledgebase apply`, which only exists once the pinned submodule contains #183. ## Summary Replaces the bundled `scripts/knowledgebase-nav/` toolchain with the DocEngine `knowledgebase` subsystem. The Python that was byte-for-byte duplicated with `coreweave/docs` now lives once in the engine and reaches hosts via Dependabot. ## Changes - **`docengine-site/knowledgebase.yaml`** — the old `config.yaml` minus `mintlify_root` (the support root is resolved from `docengine.yaml` `output_subpath` = `.`). Products and allowed keywords are unchanged. - **`docengine-site/templates/`** — the two MDX templates moved here. W&B keeps its own product-index template variant (`title: "Support: …"`, no `sidebarTitle`); templates are per-host. - **Removed `scripts/knowledgebase-nav/`** — script, report, tests, README, `Architecture.md`, `requirements.txt`. The engine owns the logic and tests now. - **`.github/workflows/knowledgebase-nav.yml`** — slimmed to: authenticate + init the `docengine` submodule (`DOCENGINE_TOKEN`), `pip install -e ./docengine`, `docengine knowledgebase apply --report-file …`, upsert the PR comment (same `<!-- knowledgebase-nav-report -->` marker), and commit the support output back with the `wandb-docs-pr-writer` App token. The engine reports its exact changed files, so the old `git add --dry-run` candidate loop is gone. ## Behavior change (forks) Generation now needs the **private** `coreweave/docengine` submodule, which fork PRs cannot clone. The job runs for **same-repo PRs and manual dispatch only**; fork PRs are regenerated by a maintainer after merge (the former bundled script could generate but never push on forks). Workflow/job names are unchanged so any required-check names still match. ## Verification The engine change (#183) was proven behavior-preserving by a differential against this repo's real `scripts/knowledgebase-nav/generate_tags.py` over the live `support/` tree (this is the `output_subpath: "."` case): the generated trees are byte-identical except the intended `template:` provenance line (`scripts/knowledgebase-nav/templates/…` → `docengine-site/templates/…`); `support.mdx` and all article footers are byte-identical. Report markdown is byte-identical to the legacy `pr_report.py`. ## Merge order 1. Merge coreweave/docengine#183. 2. Bump this repo's `docengine` submodule to include it (Dependabot). 3. Mark this PR ready and merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: wandb-docs-pr-writer[bot] <wandb-docs-pr-writer[bot]@users.noreply.github.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
1 participant
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.
Description
What does the pull request do? If it fixes a bug or resolves a feature request, be sure to link to that issue.
Ticket
Does this PR fix an existing issue? If yes, provide a link to the ticket here:
Checklist
Check if your PR fulfills the following requirements. Put an
Xin the boxes that apply.yarn start. My changes did not break the local preview.yarn docusaurus build) was run locally and successfully without errors or warnings.maininto my feature branch before submitting this PR.