From 2a21bd5880095853fea4aebfd88a9f733c7e64ef Mon Sep 17 00:00:00 2001
From: Josh Junon <josh@gitbutler.com>
Date: Wed, 3 Jan 2024 20:11:22 +0100
Subject: [PATCH] add core lib module docs

---
 gitbutler-core/src/lib.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/gitbutler-core/src/lib.rs b/gitbutler-core/src/lib.rs
index fd6bb6c43..906ade679 100644
--- a/gitbutler-core/src/lib.rs
+++ b/gitbutler-core/src/lib.rs
@@ -1 +1,11 @@
+//! # GitButler Core
+//!
+//! This crate contains the core functionality of GitButler.
+//! It is intended to be used as a library by the GitButler
+//! frontend application(s).
+//!
+//! For more information, see the
+//! [GitButler organization](https://github.com/gitbutlerapp)
+//! or the [GitButler website](https://gitbutler.com).
+
 pub mod id;