Improves PR comments from KB nav workflow#2347
Merged
Conversation
Contributor
Knowledgebase navigation update
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (49 total)📄 Pages (49)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-df-improved-kb-nav-comments.mintlify.app |
mdlinville
approved these changes
Mar 27, 2026
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.
Summary
This change replaces the knowledgebase-nav workflow’s warnings-only pull request comment with a structured navigation report that summarizes what the generator changed (using
git diffaftergenerate_tags.pyruns), and surfaces the same report in the Actions job summary for manualworkflow_dispatchruns. Fork pull requests still do not receive an automated comment (unchanged).WBDOCS-1997
Motivation
Reviewers and tech writers need a quick, repeatable summary of support navigation impact (articles, tag pages, product indexes,
docs.json, rootsupport.mdx, deletions, keyword-related counts, and unknown keywords) without reading full CI logs.Changes
Workflow (
.github/workflows/knowledgebase-nav.yml)scripts/knowledgebase-nav/pr_report.py, writes the Markdown tocomment-body.md, and upserts a single issue comment identified by<!-- knowledgebase-nav-report -->(create or PATCH; no longer deletes the comment when there are no warnings).workflow_dispatch: Appends the same Markdown (without the HTML marker) to$GITHUB_STEP_SUMMARYunder a## Knowledgebase navigation reportheading so manual runs still get feedback when there is no PR.New script (
scripts/knowledgebase-nav/pr_report.py)git diff --name-status HEADand buckets paths into counts (badges/articles, modified tag pages, product indexes, rootsupport.mdx, deletions, new tag pages, removed tag pages,docs.json).generator-warnings.logfor distinct Unknown keyword strings (aligned withgenerate_tags.build_tag_indexwarning text).--run-url.docs.json, or rootsupport.mdx.Tests (
scripts/knowledgebase-nav/tests/test_pr_report.py)Risk / review focus
<!-- knowledgebase-nav-warnings -->; new runs use<!-- knowledgebase-nav-report -->. Stale old comments may remain on historical PRs until manually removed (low impact).Test plan
pytest scripts/knowledgebase-nav/tests/test_pr_report.py -vlocally (or fullscripts/knowledgebase-nav/tests/).support/**orscripts/knowledgebase-nav/**and confirm the workflow posts or updates the navigation report comment.workflow_dispatch) and confirm the job summary includes the report (including the fallback line when the generator makes no net changes).