From 187db0183db04edb959fdd5ae6fa0c438ba33cbd Mon Sep 17 00:00:00 2001
From: Shengyu Zhang <i@silverrainz.me>
Date: Wed, 3 Jul 2024 00:29:13 +0800
Subject: [PATCH] docs: Document init

---
 docs/changelog.rst |  8 ++++++++
 docs/index.rst     | 24 ++++++++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/docs/changelog.rst b/docs/changelog.rst
index 11a401e..6e55a42 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -14,3 +14,11 @@ Change Log
       :date: yyyy-mm-dd
 
       Change log here.
+
+1.0a0
+=====
+
+.. version:: _
+   :date: 2024-07-03
+
+The first alpha version is out, enjoy~
diff --git a/docs/index.rst b/docs/index.rst
index b7345b8..ecfc733 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,6 +8,17 @@ Introduction
 
 .. ADDITIONAL CONTENT START
 
+A Sphinx builder specialized for **fast incremental HTML** build.
+
+The builtin HTML builder (``StandaloneHTMLBuilder``) supports incremental build
+too, but it have to do a lot of extra work to ensure document consistency, such
+as: updating glob toctree, updating domain index, deal with config changed, and
+so on. The fasthtml builder wraps the builtin one and **skips almost all
+operations that slow down the build** and left only the necessary parts.
+
+If you often need to edit and build Sphinx documents locally, and you only want
+to preview the parts you modified, the fasthtml builder will be helpful to you. 
+
 .. ADDITIONAL CONTENT END
 
 Getting Started
@@ -39,6 +50,19 @@ Then, add the extension name to ``extensions`` configuration item in your conf.p
 
 .. ADDITIONAL CONTENT START
 
+Then you can run the builder:
+
+.. code-block:: console
+
+   $ sphinx-build -b fasthtml <sourcedir> <outputdir>
+
+For users who build document through Makefile, it is recommended to modify the
+catch-all target as following:
+
+.. literalinclude:: Makefile
+   :language: make
+   :lines: 20-
+
 .. ADDITIONAL CONTENT END
 
 Contents