Simplify gRPC API navigation#346
Open
danielporterda wants to merge 1 commit into
Open
Conversation
d49f642 to
0477830
Compare
0477830 to
0a7cf88
Compare
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
Addresses #309 by updating the generated gRPC API navigation shape for the current Mintlify
productsnavigation.Changes
Packageswrapper underLedger API > gRPC API.Servicessubmenu.v2,v2.admin,v2.interactive, andv2.testing.Details and history.navigation.productslayout as well as the oldernavigation.dropdownslayout.Screenshots
The first screenshot shows
Ledger API > gRPC APIwithout the extraPackageswrapper. The second screenshot shows thev2package with service groups directly under it andDetails and historyat the bottom of the package group.Validation
direnv exec /Users/danielporter/control/.worktrees/cf-docs-pr-346-check python3 -m pytest tests/test_grpc_ledger_api_nav.pydirenv exec /Users/danielporter/control/.worktrees/cf-docs-pr-346-check npm run generate:grpc-ledger-api-referencePackagesorServiceslabels remain underLedger API > gRPC API, each package detail page is last, and Admin API gRPC navigation remains present.git diff --checkhttp://localhost:3072/reference/grpc-ledger-api-reference/detailsandhttp://localhost:3072/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandservice/submitandwaitNote: full
npm run generate:all-reference-docscurrently fails on currentmainoutside this PR's gRPC path because other reference generators still expectdocs.jsonnavigation.dropdownsafter the site moved tonavigation.products.