docs(): replace :::info Example with :::example #1637
Merged
+3
−3
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
✅ Deploy Preview for oasisprotocol-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR standardizes documentation admonitions by replacing :::info Example blocks with :::example blocks across the codebase, aligning with documented style guidelines.
Changes:
- Updated documentation admonition syntax from
:::info Exampleto:::example - Updated subproject commit reference for sapphire-paratime
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| external/sapphire-paratime | Updated subproject commit reference |
| docs/node/grpc.mdx | Changed :::info Example hostnames to :::example hostnames |
| docs/build/tools/foundry.mdx | Changed :::info Example: Foundry to :::example Foundry |
| docs/build/opl/hyperlane/pingpong-example.md | Changed :::info Example Code to :::example Code |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
matevz
approved these changes
Jan 15, 2026
docs/node/grpc.mdx
Outdated
| - `internal.sock` of the Oasis node is accessible at `/node/data/internal.sock`. | ||
|
|
||
| :::info Example hostnames | ||
| :::example hostnames |
Member
There was a problem hiding this comment.
Suggested change
| :::example hostnames | |
| :::example Hostnames |
njelich
force-pushed
the
njelich/replace-info-example-with-example
branch
from
1bc72d2 to
4e26f4e
Compare
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.
Resolves #1585