This repository was archived by the owner on Mar 29, 2026. It is now read-only.
Closed
Conversation
For ages the book has been the canonical source of documentation for cynic. However, it's a bit annoying having the rust documentation completely empty and just linked to the book. Particularly since every version of the crate links to just a single version of the rust docs. This is an attempt to somewhat fix that: instead of just linking to the book, we'll pull in the docs using the (relatively) new `include_str!` support inside attribute macros. This will require a bit of a reworking of the book, since there's a lot of relative links to the book (and also parts of the book that won't make sense as rust docs). But it seems like a good idea generally.
✅ Deploy Preview for cynic-querygen-web canceled.
|
Owner
Author
|
Migrated to https://codeberg.org/obmarg/cynic/pulls/1145 |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
For ages the book has been the canonical source of documentation for cynic. However, it's a bit annoying having the rust documentation completely empty and just linked to the book. Particularly since every version of the crate links to just a single version of the rust docs.
This is an attempt to somewhat fix that: instead of just linking to the book, we'll pull in the docs using the (relatively) new
include_str!support inside attribute macros.This will require a bit of a reworking of the book, since there's a lot of relative links to the book (and also parts of the book that won't make sense as rust docs). But it seems like a good idea generally.