Convert blockquotes to admonitions #6383
Merged
Conversation
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
philrz
commented
Nov 21, 2025
Comment on lines
-83
to
-88
| > The [Zui](https://zui.brimdata.io/) desktop application automatically starts a | ||
| > SuperDB database service when it launches. Therefore if you are using Zui you can | ||
| > skip the first set of commands shown above. The pool can be created from Zui | ||
| > by clicking **+**, selecting **New Pool**, then entering `ts` for the | ||
| > [pool key](../../command/db.md#sort-key). | ||
Contributor
Author
There was a problem hiding this comment.
We reached consensus that we'd drop mention of the desktop app in the docs for now, so I removed this text rather than convert to an admonition.
| the super ID. | ||
|
|
||
| > _Change the first N values to type values instead of nulls?_ | ||
| > _TODO: Change the first N values to type values instead of nulls?_ |
Contributor
Author
There was a problem hiding this comment.
The closing ? led me to assume this should be framed as a TODO.
| the tag of the union type indicating which column the value falls within. | ||
|
|
||
| > Change code to conform to columns array instead of record{c0,c1,...} | ||
| > _TODO: Change code to conform to columns array instead of record{c0,c1,...}_ |
Contributor
Author
There was a problem hiding this comment.
Since this was a statement about a likely code change I converted it to a TODO.
Comment on lines
-40
to
-48
| ### Copy to CLI | ||
|
|
||
| If you want to transfer a working playground query to your shell, just | ||
| click on CLI tab and you will see text suitable for pasting into a | ||
| `bash`, `zsh`, etc. | ||
|
|
||
| > Note that there is no special quoting for the shell so you may run | ||
| > into problems if you mix single and double quotes in your query. | ||
Contributor
Author
There was a problem hiding this comment.
Dropped this text since we removed the functionality in #6378.
mccanne
approved these changes
Nov 21, 2025
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.
tl;dr
This converts blockquotes in the docs to mdbook admonitions.
Details
For the most part I did just conversion and resisted the urge to do major corrections to the content, but did make a few adjustments if it seemed silly to convert content we've already agreed should go/change. I've made inline comments to call attention to these.
The way we were using blockquotes before, we had a loose convention of putting the text in italics for extra emphasis, but since the admonitions have the icon, colored vertical bar, and colored background, that seemed like enough emphasis that while touching all these I standardized on dropping the italics.
TODO items called out in the docs have been left as blockquotes.