docs: fix references in public docs - #2937
Open
JosephLenton wants to merge 4 commits into
Open
Conversation
JosephLenton
marked this pull request as ready for review
July 31, 2026 22:02
dannycjones
suggested changes
Aug 3, 2026
dannycjones
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this change, @JosephLenton! I think it's important that we maintain good hygiene on the docs.
I think there's a few things highlighted by the lints where we're better addressing the root cause. For example: types that we thought were public but actually aren't, and need exporting.
JosephLenton
force-pushed
the
fix-doc-links
branch
from
August 6, 2026 07:28
3832bf0 to
7069a6e
Compare
Author
|
Hey @dannycjones I have updated the PR to now export all of the bits I could find, and made further updates to the docs. When you get time could you please give this a second review. |
JosephLenton
force-pushed
the
fix-doc-links
branch
from
August 6, 2026 20:15
78a4881 to
d1da94d
Compare
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.
Which issue does this PR close?
What changes are included in this PR?
https://example.comto<https://example.com>.The following items were previously mentioned in the docs, but were not public. They are now publicaly exported:
Are these changes tested?
These changes were QA'd by running
cargo doc --no-deps.AI Disclosure
I got Claude to do most of the changes in this PR.