Skip to content

Commit

Permalink
heading level and doc for masonry readme (#770)
Browse files Browse the repository at this point in the history
Update the Masonry readme with documentation on how it is generated and
change the heading level to be consistent with Color
  • Loading branch information
KGrewal1 authored Dec 6, 2024
1 parent 3aebc98 commit 363e422
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ jobs:

- name: cargo rdme masonry
run: |
cargo rdme --check --workspace-project=masonry
cargo rdme --check --heading-base-level=0 --workspace-project=masonry
- name: cargo rdme tree_arena
run: |
Expand Down
7 changes: 7 additions & 0 deletions masonry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@

</div>

<!-- We use cargo-rdme to update the README with the contents of lib.rs.
To edit the following section, update it in lib.rs, then run:
cargo rdme --workspace-project=color --heading-base-level=0
Full documentation at https://github.com/orium/cargo-rdme -->

<!-- Intra-doc links used in lib.rs should be evaluated here.
See https://linebender.org/blog/doc-include/ for related discussion. -->
[tracing_tracy]: https://crates.io/crates/tracing-tracy

<!-- cargo-rdme start -->
Expand Down
4 changes: 2 additions & 2 deletions masonry/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
//! Masonry can currently be considered to be in an alpha state.
//! Lots of things need improvements, e.g. text input is janky and snapshot testing is not consistent across platforms.
//!
//! # Example
//! ## Example
//!
//! The to-do-list example looks like this:
//!
Expand Down Expand Up @@ -77,7 +77,7 @@
//!
//! For more information, see [the documentation module](crate::doc).
//!
//! ## Crate feature flags
//! ### Crate feature flags
//!
//! The following feature flags are available:
//!
Expand Down

0 comments on commit 363e422

Please sign in to comment.