feat(json): add fm description to generic and contributor (#242)

Author: fiji-flo

crates/rari-doc/src/pages/build.rs

@@ -30,7 +30,7 @@ use crate::html::sections::{split_sections, BuildSection, BuildSectionType, Spli
 use crate::html::sidebar::{
     build_sidebars, expand_details_and_mark_current_for_inline_sidebar, postprocess_sidebar,
 };
-use crate::pages::json::JsonContributorSpotlightPage;
+use crate::pages::json::{CommonJsonData, JsonContributorSpotlightPage};
 use crate::pages::types::blog::BlogPost;
 use crate::pages::types::curriculum::{
     build_landing_modules, build_overview_modules, build_sidebar, curriculum_group,
@@ -368,6 +368,9 @@ fn build_generic_page(page: &Generic) -> Result<BuiltPage, DocError> {
                 },
                 url: page.meta.url.clone(),
                 id: page.meta.page.clone(),
+                common: CommonJsonData {
+                    description: page.meta.description.clone(),
+                },
             },
             page.meta.template,
         ),
@@ -440,6 +443,9 @@ fn build_contributor_spotlight(cs: &ContributorSpotlight) -> Result<BuiltPage, D
             url: cs.meta.url.clone(),
             page_title: cs.meta.title.clone(),
             hy_data: contributor_spotlight_data,
+            common: CommonJsonData {
+                description: cs.meta.description.clone(),
+            },
         }),
     )))
 }

crates/rari-doc/src/pages/json.rs

@@ -596,6 +596,7 @@ pub struct ContributorSpotlightHyData {
 /// * `url` - A `String` that holds the URL of the contributor spotlight page.
 /// * `page_title` - A `String` that holds the title of the contributor spotlight page. Serialized as `pageTitle`.
 /// * `hy_data` - A `ContributorSpotlightHyData` that holds the data related to the contributor. Serialized as `hyData`.
+/// * `common` - Common data, e.g. description.
 #[derive(Debug, Clone, Serialize, JsonSchema)]
 #[schemars(rename = "ContributorSpotlightPage")]
 pub struct JsonContributorSpotlightPage {
@@ -604,6 +605,8 @@ pub struct JsonContributorSpotlightPage {
     pub page_title: String,
     #[serde(rename = "hyData")]
     pub hy_data: ContributorSpotlightHyData,
+    #[serde(flatten)]
+    pub common: CommonJsonData,
 }
 
 /// Represents the different JSON artifacts of built pages.
@@ -923,6 +926,7 @@ pub struct JsonGenericHyData {
 /// * `page_title` - A `String` that holds the title of the generic page.
 /// * `url` - A `String` that holds the URL of the generic page.
 /// * `id` - A `String` that holds the unique identifier for the generic page.
+/// * `common` - Common data, e.g. description.
 #[derive(Debug, Clone, Serialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 #[schemars(rename = "GenericPage")]
@@ -931,4 +935,13 @@ pub struct JsonGenericPage {
     pub page_title: String,
     pub url: String,
     pub id: String,
+    #[serde(flatten)]
+    pub common: CommonJsonData,
+}
+
+#[derive(Debug, Clone, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+#[schemars(rename = "GenericPage")]
+pub struct CommonJsonData {
+    pub description: Option<String>,
 }

crates/rari-doc/src/pages/types/contributors.rs

@@ -29,6 +29,7 @@ pub struct ContributorFrontMatter {
     pub img_alt: String,
     pub usernames: Usernames,
     pub quote: String,
+    pub description: Option<String>,
 }
 
 #[derive(Serialize, Clone, Debug)]
@@ -42,6 +43,7 @@ pub struct ContributorMeta {
     pub img_alt: String,
     pub usernames: Usernames,
     pub quote: String,
+    pub description: Option<String>,
 }
 
 #[derive(Serialize, Clone, Debug)]
@@ -59,6 +61,7 @@ pub struct ContributorBuildMeta {
     pub quote: String,
     pub path: PathBuf,
     pub full_path: PathBuf,
+    pub description: Option<String>,
 }
 
 impl From<&ContributorBuildMeta> for ContributorMeta {
@@ -73,6 +76,7 @@ impl From<&ContributorBuildMeta> for ContributorMeta {
             img_alt,
             usernames,
             quote,
+            description,
             ..
         } = value;
         ContributorMeta {
@@ -85,6 +89,7 @@ impl From<&ContributorBuildMeta> for ContributorMeta {
             img_alt: img_alt.clone(),
             usernames: usernames.clone(),
             quote: quote.clone(),
+            description: description.clone(),
         }
     }
 }
@@ -108,6 +113,7 @@ impl ContributorBuildMeta {
             img_alt,
             usernames,
             quote,
+            description,
         } = fm;
         let slug = concat_strs!("spotlight/", folder_name.as_str());
         Ok(Self {
@@ -128,6 +134,7 @@ impl ContributorBuildMeta {
             quote,
             full_path,
             path,
+            description,
         })
     }
 }

crates/rari-doc/src/pages/types/generic.rs

@@ -25,6 +25,7 @@ pub enum Template {
 pub struct GenericFrontmatter {
     pub title: String,
     pub template: Option<Template>,
+    pub description: Option<String>,
 }
 
 #[derive(Debug, Clone)]
@@ -38,6 +39,7 @@ pub struct GenericMeta {
     pub title_suffix: Option<String>,
     pub page: String,
     pub template: Template,
+    pub description: Option<String>,
 }
 
 impl GenericMeta {
@@ -68,6 +70,7 @@ impl GenericMeta {
             title_suffix,
             page,
             template: fm.template.unwrap_or_default(),
+            description: fm.description,
         })
     }
 }