docs: add README.md to bolt-lang crate#219
Open
Ansh-699 wants to merge 1 commit intomagicblock-labs:mainfrom
Open
docs: add README.md to bolt-lang crate#219Ansh-699 wants to merge 1 commit intomagicblock-labs:mainfrom
Ansh-699 wants to merge 1 commit intomagicblock-labs:mainfrom
Conversation
Add a README.md for the bolt-lang crate so it renders on crates.io. Includes overview, feature list, installation, usage examples, and doc links. Closes magicblock-labs#206
WalkthroughAdds a README.md file to the bolt-lang crate documenting its purpose, features, installation, usage examples, and license information. Updates the Cargo.toml manifest to reference the new README file for crate publication metadata. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Problem
The bolt-lang crate page on crates.io has an empty README, making it harder for new users to understand what the crate provides.
Solution
Added a README.md to
crates/bolt-lang/covering:#[component],#[system], etc.)Also added the
readmefield toCargo.tomlso crates.io renders it on next publish.Closes #206
Summary by CodeRabbit