Pin weave.init to top of TypeScript SDK reference nav#2937
Draft
dbrian57 wants to merge 1 commit into
Draft
Conversation
The TOC script sorted every symbol alphabetically inside its kind group, which buried init — the primary entry point — mid-list under Functions. Add a priority list that pins headline pages directly after the landing page and filters them out of their alphabetical subgroup. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (1 total)⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
HiveMind Sessions1 session · 2m · $2.25
View all sessions in HiveMind → 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
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
The Mintlify sidebar for the Weave TypeScript SDK reference is built by
scripts/reference-generation/weave/update_weave_toc.py, which sorted every symbol alphabetically within its kind group (Classes, Functions, Interfaces, Type Aliases). That buriedinit— the SDK's primary entry point — mid-list inside the Functions group, below all 15 classes.This PR adds a
TYPESCRIPT_PRIORITY_PAGESlist to the TOC script. Pages in the list are pinned directly after thetypescript-sdklanding page in the nav and filtered out of their alphabetical subgroup so they don't appear twice. Only pages that were actually generated in a given run get pinned, and any subgroup left empty by the filtering is dropped. Promoting other headline APIs later (e.g.op,login) is a one-line addition to the list.docs.jsonwas regenerated by running the script; the diff is limited to movingweave/reference/typescript-sdk/functions/initfrom the Functions group to the second item in the TypeScript SDK section.Note for reviewers: TypeDoc-side metadata (
@group/@category,sortoptions) was considered and rejected — it only affects the generated markdown content, notdocs.json, so it can't influence the Mintlify nav. A manualdocs.jsonedit would also be overwritten on the next TOC regeneration, which is why the ordering logic lives in the script.Testing
python3 scripts/reference-generation/weave/update_weave_toc.py; thedocs.jsondiff contains only the intendedinitmove, confirming the change is idempotent against the existing generated pages.🤖 Generated with Claude Code