From 27bd5024e04e4e7d236a9b18112c7b876bae5633 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Wed, 17 Jun 2026 22:22:45 +0800
Subject: docs: add module documentation and rename constants for clarity

Add doc comments to lib, consts, and common modules
Rename ROLA_DRAFT_DIR and ROLA_BINDED_BUCKET_FILE to DRAFT_META_DIR
---
 rola-vcs/src/consts/common.rs |  4 ++--
 rola-vcs/src/consts/mod.rs    |  4 ++++
 rola-vcs/src/lib.rs           | 10 ++++++++++
 3 files changed, 16 insertions(+), 2 deletions(-)

(limited to 'rola-vcs')

diff --git a/rola-vcs/src/consts/common.rs b/rola-vcs/src/consts/common.rs
index e2bfd8c..4960f1b 100644
--- a/rola-vcs/src/consts/common.rs
+++ b/rola-vcs/src/consts/common.rs
@@ -1,7 +1,7 @@
 #[rorolala_internal_macros::constants]
 mod consts {
-    pub const ROLA_DRAFT_DIR: &str = ".rola";
-    pub const ROLA_BINDED_BUCKET_FILE: &str = ".rola/BIND/{bucket}";
+    /// Directory name for Rorolala metadata storage in Workdraft
+    pub const DRAFT_META_DIR: &str = ".rola";
 }
 
 pub use consts::*;
diff --git a/rola-vcs/src/consts/mod.rs b/rola-vcs/src/consts/mod.rs
index 598ae17..8b1113b 100644
--- a/rola-vcs/src/consts/mod.rs
+++ b/rola-vcs/src/consts/mod.rs
@@ -1,2 +1,6 @@
+//! Rorolala Constants
+//!
+//! This module records all constant information for Rorolala
+
 mod common;
 pub use common::*;
diff --git a/rola-vcs/src/lib.rs b/rola-vcs/src/lib.rs
index ac52569..4d8f5e3 100644
--- a/rola-vcs/src/lib.rs
+++ b/rola-vcs/src/lib.rs
@@ -1,9 +1,19 @@
+//! libroroalala
+
 #![allow(unused)]
 
+/// Rorolala - Bucket
+///
+/// This module records the interaction logic of Rorolala Bucket
+/// Bucket can be operated directly
 pub mod bucket {
     pub use rola_bucket::*;
 }
 
+/// Rorolala - Draft
+///
+/// This module records the interaction logic of Rorolala Workdraft
+/// Workdraft can be operated directly
 pub mod draft {
     pub use rola_draft::*;
 }
-- 
cgit