chore(generic-content): rename generic pages to match repo name (#43)

Co-authored-by: Florian Dieminger <[email protected]>

Author: LeoMcA

Diff for: crates/rari-doc/src/build.rs

@@ -17,7 +17,8 @@ use sha2::{Digest, Sha256};
 use tracing::{span, Level};
 
 use crate::cached_readers::{
-    blog_files, contributor_spotlight_files, curriculum_files, generic_pages_files, wiki_histories,
+    blog_files, contributor_spotlight_files, curriculum_files, generic_content_files,
+    wiki_histories,
 };
 use crate::contributors::contributors_txt;
 use crate::error::DocError;
@@ -234,7 +235,7 @@ pub fn build_blog_pages<'a>() -> Result<Vec<SitemapMeta<'a>>, DocError> {
 /// This function will return an error if:
 /// - An error occurs while building any of the generic pages.
 pub fn build_generic_pages<'a>() -> Result<Vec<SitemapMeta<'a>>, DocError> {
-    generic_pages_files()
+    generic_content_files()
         .values()
         .map(|page| {
             build_single_page(page).map(|_| SitemapMeta {

Diff for: crates/rari-doc/src/cached_readers.rs

@@ -18,7 +18,7 @@
 //!
 //! - **Specialized Caches**: These caches store specific types of documentation content.
 //!   - `CACHED_CURRICULUM`: Stores curriculum files, indexed by URL, path, and index,
-//!   - `GENERIC_PAGES_FILES`: Stores generic pages indexed by URL.
+//!   - `GENERIC_CONTENT_FILES`: Stores generic pages indexed by URL.
 //!   - `CONTRIBUTOR_SPOTLIGHT_FILES`: Stores contributor spotlight pages indexed by URL.
 
 use std::borrow::Cow;
@@ -30,7 +30,7 @@ use std::sync::{Arc, LazyLock, OnceLock};
 use dashmap::DashMap;
 use rari_types::globals::{
     blog_root, cache_content, content_root, content_translated_root, contributor_spotlight_root,
-    curriculum_root, generic_pages_root,
+    curriculum_root, generic_content_root,
 };
 use rari_types::locale::Locale;
 use rari_utils::concat_strs;
@@ -63,7 +63,7 @@ type SidebarFilesCache = Arc<DashMap<(String, Locale), Arc<MetaSidebar>>>;
 pub(crate) static CACHED_SIDEBAR_FILES: LazyLock<SidebarFilesCache> =
     LazyLock::new(|| Arc::new(DashMap::new()));
 pub(crate) static CACHED_CURRICULUM: OnceLock<CurriculumFiles> = OnceLock::new();
-pub(crate) static GENERIC_PAGES_FILES: OnceLock<UrlToPageMap> = OnceLock::new();
+pub(crate) static GENERIC_CONTENT_FILES: OnceLock<UrlToPageMap> = OnceLock::new();
 pub(crate) static CONTRIBUTOR_SPOTLIGHT_FILES: OnceLock<UrlToPageMap> = OnceLock::new();
 pub(crate) static WIKI_HISTORY: OnceLock<WikiHistories> = OnceLock::new();
 
@@ -241,8 +241,8 @@ fn gather_blog_posts() -> Result<HashMap<String, Page>, DocError> {
     }
 }
 
-fn gather_generic_pages() -> Result<HashMap<String, Page>, DocError> {
-    if let Some(root) = generic_pages_root() {
+fn gather_generic_content() -> Result<HashMap<String, Page>, DocError> {
+    if let Some(root) = generic_content_root() {
         Ok(read_docs_parallel::<GenericPage>(&[root], Some("*.md"))?
             .into_iter()
             .filter_map(|page| {
@@ -261,7 +261,7 @@ fn gather_generic_pages() -> Result<HashMap<String, Page>, DocError> {
             .map(|page| (page.url().to_ascii_lowercase(), page))
             .collect())
     } else {
-        Err(DocError::NoGenericPagesRoot)
+        Err(DocError::NoGenericContentRoot)
     }
 }
 
@@ -338,7 +338,7 @@ fn gather_contributre_spotlight() -> Result<HashMap<String, Page>, DocError> {
             .map(|page| (page.url().to_ascii_lowercase(), page))
             .collect())
     } else {
-        Err(DocError::NoGenericPagesRoot)
+        Err(DocError::NoGenericContentRoot)
     }
 }
 
@@ -521,22 +521,22 @@ pub type UrlToPageMap = HashMap<String, Page>;
 ///
 /// This function returns a `Cow<'static, UrlToPageMap>` containing the generic pages.
 /// If caching is enabled (as determined by `cache_content()`), it attempts to get the cached
-/// generic pages from `GENERIC_PAGES_FILES`, initializing it if needed.
+/// generic pages from `GENERIC_CONTENT_FILES`, initializing it if needed.
 /// If caching is not enabled, it directly reads the generic pages and returns them.
 ///
 /// # Returns
 ///
 /// * `Cow<'static, UrlToPageMap>` - Returns a `Cow::Borrowed` containing the cached generic pages
 ///   if caching is enabled. Otherwise, returns a `Cow::Owned` containing the read-in generic pages.
-pub fn generic_pages_files() -> Cow<'static, UrlToPageMap> {
+pub fn generic_content_files() -> Cow<'static, UrlToPageMap> {
     fn gather() -> UrlToPageMap {
-        gather_generic_pages().unwrap_or_else(|e| {
+        gather_generic_content().unwrap_or_else(|e| {
             error!("{e}");
             Default::default()
         })
     }
     if cache_content() {
-        Cow::Borrowed(GENERIC_PAGES_FILES.get_or_init(gather))
+        Cow::Borrowed(GENERIC_CONTENT_FILES.get_or_init(gather))
     } else {
         Cow::Owned(gather())
     }

Diff for: crates/rari-doc/src/error.rs

@@ -26,8 +26,8 @@ pub enum DocError {
     NoSuchPrefix(#[from] StripPrefixError),
     #[error("No curricm root set")]
     NoCurriculumRoot,
-    #[error("No generic pages roots set")]
-    NoGenericPagesRoot,
+    #[error("No generic content root set")]
+    NoGenericContentRoot,
     #[error("No H1 found")]
     NoH1,
     #[error(transparent)]

Diff for: crates/rari-doc/src/pages/types/generic.rs

@@ -2,14 +2,14 @@ use std::path::{Path, PathBuf};
 use std::sync::Arc;
 
 use rari_types::fm_types::{FeatureStatus, PageType};
-use rari_types::globals::generic_pages_root;
+use rari_types::globals::generic_content_root;
 use rari_types::locale::Locale;
 use rari_types::RariEnv;
 use rari_utils::concat_strs;
 use rari_utils::io::read_to_string;
 use serde::Deserialize;
 
-use crate::cached_readers::generic_pages_files;
+use crate::cached_readers::generic_content_files;
 use crate::error::DocError;
 use crate::pages::page::{Page, PageLike, PageReader};
 use crate::utils::split_fm;
@@ -68,7 +68,7 @@ impl PageReader for GenericPage {
         locale: Option<Locale>,
     ) -> Result<crate::pages::page::Page, DocError> {
         let path = path.into();
-        let root = generic_pages_root().ok_or(DocError::NoGenericPagesRoot)?;
+        let root = generic_content_root().ok_or(DocError::NoGenericContentRoot)?;
         let without_root: &Path = path.strip_prefix(root)?;
         let (slug_prefix, title_suffix, root) = if without_root.starts_with("plus/") {
             (Some("plus/docs"), "MDN Plus", root.join("plus"))
@@ -106,7 +106,7 @@ pub struct GenericPage {
 impl GenericPage {
     pub fn from_slug(slug: &str, locale: Locale) -> Option<Page> {
         let url = concat_strs!("/", locale.as_url_str(), "/", slug).to_ascii_lowercase();
-        generic_pages_files().get(&url).cloned()
+        generic_content_files().get(&url).cloned()
     }
 
     pub fn as_locale(&self, locale: Locale) -> Self {
@@ -126,7 +126,7 @@ impl GenericPage {
 
     pub fn is_generic(slug: &str, locale: Locale) -> bool {
         let url = concat_strs!("/", locale.as_url_str(), "/", slug).to_ascii_lowercase();
-        generic_pages_files().contains_key(&url)
+        generic_content_files().contains_key(&url)
     }
 }
 

Diff for: crates/rari-types/src/globals.rs

@@ -21,8 +21,8 @@ pub fn blog_root() -> Option<&'static Path> {
 }
 
 #[inline(always)]
-pub fn generic_pages_root() -> Option<&'static Path> {
-    settings().generic_pages_root.as_deref()
+pub fn generic_content_root() -> Option<&'static Path> {
+    settings().generic_content_root.as_deref()
 }
 #[inline(always)]
 pub fn curriculum_root() -> Option<&'static Path> {

Diff for: crates/rari-types/src/settings.rs

@@ -12,7 +12,7 @@ pub struct Settings {
     pub content_translated_root: Option<PathBuf>,
     pub build_out_root: Option<PathBuf>,
     pub blog_root: Option<PathBuf>,
-    pub generic_pages_root: Option<PathBuf>,
+    pub generic_content_root: Option<PathBuf>,
     pub curriculum_root: Option<PathBuf>,
     pub contributor_spotlight_root: Option<PathBuf>,
     pub deny_warnings: bool,