Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Knowledgebase navigation updateNo updates to support articles, tag pages, or product indexes from this run. |
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.
Summary
Stops the knowledgebase-nav pipeline from reading, writing, or parsing
docs.json. Tag pages, product indexes, article tab-badge sync, and rootsupport.mdxbehavior are unchanged. When tag pages are added, removed, or renamed (treated as delete + add), the PR report (pr_report.py) now emits a docs.json update required section that lists the exact Mintlify page ids to add or remove, grouped by product (Support: <display_name>), using display names fromscripts/knowledgebase-nav/config.yaml.Motivation
Mintlify navigation in
docs.jsonis intended to be edited by humans. The generator should not mutate navigation automatically.Changes
scripts/knowledgebase-nav/generate_tags.pyupdate_docs_json,DOCS_JSON_NAV_LANGUAGE, and the post-loopdocs.jsonphase.support.mdxupdates; docstrings and CLI help updated accordingly.scripts/knowledgebase-nav/pr_report.pydocs_jsonbucket from categorization and the- docs.json updated.bullet.collect_tag_page_changes()fromgit diff --name-status HEADlines: mapssupport/<product>/tags/<slug>.mdxto page ids (strip.mdx); handlesA,D, and rename/copy (R/C) as add + remove.load_product_display_names()fromconfig.yaml; optional--config(default<repo-root>/scripts/knowledgebase-nav/config.yaml).build_docs_json_section()and wired intobuild_report_markdown; fallback body is skipped when only tag-page add/remove lists are non-empty..github/workflows/knowledgebase-nav.ymldocs.jsonedits via PR comment.chore: regenerate support tag pages(matchesCHORE_SUBJECTfor chore-only detection);file_patternno longer includesdocs.json.Tests
test_generate_tags.py: RemovedTestUpdateDocsJson; fixture no longer seedsdocs.json; full pipeline assertsdocs.jsonis not created; light regression checks thatupdate_docs_jsonis gone and the module does not path-opendocs.json.test_golden_output.py: Removed golden assertions againstdocs.json; fixture copies onlysupport/+support.mdx; asserts nodocs.jsonappears after the run.test_pr_report.py: New coverage for tag-page collection, the docs.json section, display-name fallback, YAML loading edge cases, and updated categorization (e.g.M docs.jsonno longer increments adocs_jsonbucket).Docs
README.mdandArchitecture.md: Describe human-manageddocs.json, PR comment workflow, new-product tab JSON snippet, CI file patterns, troubleshooting, and updated mermaid diagrams (noGEN --> docs.json).Breaking change / migration
Workflow behavior: Commits from the Knowledgebase Nav workflow no longer include
docs.json. Authors and reviewers must apply navigation edits manually when tag pages change.Operational: PRs that previously relied on the bot to refresh support tabs must instead use the docs.json update required block in the PR comment (or edit
docs.jsonlocally). Rename an auto-commit subject string: anything that matchedchore: regenerate support tag pages and docs.json navigationshould usechore: regenerate support tag pagesfor chore-only / skip-comment logic.How to verify
python -m pytest scripts/knowledgebase-nav/tests/ -vpython scripts/knowledgebase-nav/generate_tags.py --repo-root .git statusdoes not showdocs.jsonmodified.python scripts/knowledgebase-nav/pr_report.py --repo-root . --diff-text $'A\tsupport/models/tags/foo.mdx\n' --warnings-file /dev/null### docs.json update requiredand groupedSupport: …headings.Risk / review focus
docs.jsonwhen tag pages change (README calls this out).config.yamlis missing or malformed, headings fall back toSupport: <slug>; confirm that is acceptable for edge cases.Commit
e5067feb6— Remove docs.json update logic