From 363e4222c29cbddf174570af5d4a5b448d3fb73e Mon Sep 17 00:00:00 2001
From: Kirpal Grewal <45569241+KGrewal1@users.noreply.github.com>
Date: Fri, 6 Dec 2024 11:43:12 +0000
Subject: [PATCH] heading level and doc for masonry readme (#770)

Update the Masonry readme with documentation on how it is generated and
change the heading level to be consistent with Color
---
 .github/workflows/ci.yml | 2 +-
 masonry/README.md        | 7 +++++++
 masonry/src/lib.rs       | 4 ++--
 3 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b7071f009..34243c59c 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -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: |
diff --git a/masonry/README.md b/masonry/README.md
index a27f5febb..fd6d4e5c7 100644
--- a/masonry/README.md
+++ b/masonry/README.md
@@ -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 -->
diff --git a/masonry/src/lib.rs b/masonry/src/lib.rs
index 3d87e191c..27b6b31a4 100644
--- a/masonry/src/lib.rs
+++ b/masonry/src/lib.rs
@@ -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:
 //!
@@ -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:
 //!