Docs clarity alias notices#7367
Merged
brice-stacks merged 2 commits intoJul 1, 2026
Merged
Conversation
This allows us to include a structured caveat/warning/info note about a function or keyword that downstream documentation generators can render however they like (e.g. as a GitBook hint block). Hand-written equivalents previously lived in the documentation repos; surfacing them here keeps the source-of-truth in the same place as the API definitions. Used in stacks-network/docs to generate the Clarity doc pages.
Contributor
Author
Coverage Report for CI Build 28460909251Coverage increased (+0.3%) to 86.039%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions9069 previously-covered lines in 129 files lost coverage.
Coverage Stats
💛 - Coveralls |
hstove-stacks
approved these changes
Jun 30, 2026
Merged
via the queue into
stacks-network:develop
with commit Jul 1, 2026
4d485b1
231 of 234 checks passed
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
4 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 allows us to include a structured caveat/warning/info note about
a function or keyword that downstream documentation generators can
render however they like (e.g. as a GitBook hint block). Hand-written
equivalents previously lived in the documentation repos; surfacing them
here keeps the source-of-truth in the same place as the API
definitions.
To be used in stacks-network/docs to generate the Clarity doc pages.