Deduplicate docs #29
Merged
Deduplicate docs #29
Conversation
This file contains 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
|
Note this build on top of #24 |
sjoerdsimons
force-pushed
the
sjoerd/deduplicate-docs
branch
from
dca98ba to
ba2aea6
Compare
sjoerdsimons
force-pushed
the
sjoerd/deduplicate-docs
branch
from
ba2aea6 to
7361057
Compare
Since Rust 1.54 `include_str!` can be used in the doc attribute to include external files. Take advantage of that to re-use a single README.md for both crate-level docs as well as discoverable documentation in github. Signed-off-by: Sjoerd Simons <[email protected]>
Now that he main README moved into the gitlab-runner crate re-add a small README at the root Signed-off-by: Sjoerd Simons <[email protected]>
sjoerdsimons
force-pushed
the
sjoerd/deduplicate-docs
branch
from
7361057 to
2a8e7eb
Compare
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.
Rust makes it easy to use external files in crate documentation, take advantage of that to de-duplicate the README.md and the create level documentation