docs: update template and fix help#218
Merged
Merged
Conversation
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 7 |
| Duplication | 0 |
TIP This summary will be updated as you push new changes.
dylantientcheu
approved these changes
May 13, 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.
This PR improves the MDX template for making the CLI command reference look better on Mintlify.
It also fixes a small bug in 1.8.4 where the help flag for
--reRankingApplyFilterand--insideBoundingBoxwas empty. This was due to an incomplete handling of the OpenAPI spec when generating the flags. The parameters areoneOfand the description is in a child of theoneOf, not on the parameter itself.I already applied the new template to the docs in https://github.com/algolia/docs-new/pull/820, so technically a new release isn't immediately needed.