Use cargo-rdme to sync README and documentation root
#435
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
|
Not sure what's up with the "expected check". I guess this is because I renamed one of the CI tasks, but I don't know if that will block a merge or what the proper way to do a rename is. |
DJMcNab
approved these changes
Jul 18, 2024
|
Some screenshots to feed the discussion: Masonry README before the change
Masonry README after the change
Doc page with the blurb centered
Doc page with badges and the blurb, both centered
Overall my takeaways are:
Will push follow-up commit soon based on those takeaways. |
|
New version pushed. |
DJMcNab
approved these changes
Jul 22, 2024
| @@ -1,15 +1,18 @@ | |||
| // Copyright 2018 the Xilem Authors and the Druid Authors | |||
| // SPDX-License-Identifier: Apache-2.0 | |||
|
|
|||
| //! A framework that aims to provide the foundation for Rust GUI libraries. | |||
| //! | |||
| //! Masonry gives you a platform to create windows (using [winit] as a backend) each with a tree of widgets. It also gives you tools to inspect that widget tree at runtime, write unit tests on it, and generally have an easier time debugging and maintaining your app. | |||
There was a problem hiding this comment.
I think this first sentence should be rewritten, but that's not required in this PR.
Co-authored-by: Daniel McNab <36049421+DJMcNab@users.noreply.github.com>
Changed the name as per your commit. I'd say this is good to merge. |
DJMcNab
added a commit
to DJMcNab/color
that referenced
this pull request
Nov 13, 2024
See linebender/xilem#435 and https://github.com/orium/cargo-rdme Also adds documentation for the `std` and `libm` features
github-merge-queue bot
pushed a commit
to linebender/color
that referenced
this pull request
Nov 13, 2024
See linebender/xilem#435 and https://github.com/orium/cargo-rdme Also adds documentation for the `std` and `libm` features
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.
This was remarkably painless.
I especially appreciate @taiki-e providing an install-action which does 90% of the CI work for us.