Make rustdoc hold most documentation#331
Merged
Merged
Conversation
giuseppe
reviewed
Jun 26, 2026
Collaborator
Author
|
Ah, the random proptest run in this PR caught a bug, #332 |
I want composefs to have a website with useful docs. After some reflection, what I think is the least effort and most clear right now is just to move things into the Rust documentation. So things like the repository format, splitstream definition now live there. The pattern is that we have `#[cfg(doc)] mod foo;` for things that only need to live in docs. Add information about varlink there too. Assisted-by: OpenCode (claude-opus-4-6) Signed-off-by: Colin Walters <walters@verbum.org>
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
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
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.
I want composefs to have a website with useful docs. After some reflection, what I think is the least effort and most clear right now is just to move things into the Rust documentation.
So things like the repository format, splitstream definition now live there. The pattern is that we have
#[cfg(doc)] mod foo;for things that only need to live in docs.Add information about varlink there too.
Assisted-by: OpenCode (claude-opus-4-6)