fix(docs): Update and fix crate documentation for docs.rs, update README #769
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
XAMPPRocky
approved these changes
May 5, 2025
|
Doctest should be fixed now @XAMPPRocky ! |
|
Thank you for your PR, and congrats on your first contribution! 🎉 |
Merged
|
Happy to help! And if you are inclined to chat about OSS funding, please let me know :) |
|
Thank you but blockchain projects are not permitted or welcome to be associated with my projects. |
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.
I went ahead and revamped the documentation, since a few modules were not being exported properly (like
users) and other parts of the docs had broken links or weren't up to date with the latest features.Closes #759, and almost all the warnings generated by
cargo docs.To test the resulting output, you can run
RUSTDOCFLAGS="--cfg docsrs" rustup run nightly cargo doc --all-features --no-deps --open.Thanks for creating Octocrab. Looking forward to upstreaming some more improvements in the future, like getting the API abstractions up to parity with Github.
As an aside, if you are open to a new source of funding for your open source work, we'd love to chat. Please feel free to reach out to me directly through twitter or my email on my website.