docs: Enhance README formatting and fix relative links #146
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
* Converted warning section to GitHub-style admonition block using `> [!WARNING]` for better visual clarity * Updated relative links for `CONTRIBUTING.md` and `examples/` directory to use markdown link syntax with cleaner URLs * Applied the same changes to both `README.md` and the source version at `internal/readme/README.src.md` to maintain consistency
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 formatting and internal link structure of both the main
README.mdand the source file atinternal/readme/README.src.md. Changes include:🛠 Changes Made
> [!WARNING]) for improved visibility and consistency with other docs.Example:
Warning
The SDK should be considered unreleased, and is currently unstable
and subject to breaking changes. Please test it out and file bug reports or API
proposals, but don't use it in real projects. See the issue tracker for known
issues and missing features. We aim to release a stable version of the SDK in
August, 2025.
CONTRIBUTING.mdreference to[CONTRIBUTING.md](/CONTRIBUTING.md)examples/reference to[examples/](/examples/)📌 Why It Matters
These changes improve the readability and usability of the documentation, especially when viewed on GitHub. The updated formatting helps call attention to important warnings, and fixing relative paths ensures that links work reliably across platforms and contexts.