Repository navigation
Help: help-tree.json, the index the VSCode Help view is built from - #252
Merged
Merged
Conversation
Help/markdown/vscode/help-tree.json lists the Help view's tree: labels, icons, pages, folders, and the folders filled from files (LLM prompts, helpful links, announcements, version notes). The NLP extension (4.3.17) reads it, so adding or reordering a help page is now an edit here and a visualtext-files release, with no extension update. It matches the tree the extension shows today, Large Files included. check-help-docs.ps1 gets a check 1c that fails when an entry's page does not exist, an entry has no label, a source is unknown, or the JSON does not parse. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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
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.
Adds
Help/markdown/vscode/help-tree.json, the index the VSCode Help view is built from. With it, adding or reordering a help page is an edit here plus a visualtext-files release. The extension no longer needs an update.The index
Each entry has a
labeland anicon, plus one of:page: a markdown page underHelp/markdown/, without.mdurl: an external linkchildren: a folder of more entriessource: a folder filled from files on disk (prompts,links,announcementsorversions)Optional:
tooltip, andexpandedto have a folder start open. The file matches the tree the extension shows today, Large Files included.Check
check-help-docs.ps1adds check 1c. It fails when an entry's page doesn't exist, an entry has no label, asourceis unknown, or the JSON doesn't parse. I ran it on this file (passes) and on a broken copy (fails, listing both errors).The extension side is in visualtext/vscode-nlp (4.3.17). It falls back to a built-in tree when this file is missing, so the two PRs can merge in either order.
🤖 Generated with Claude Code