From 020ebdb41c5bab1183f6f72c9d283f4f0d862ee0 Mon Sep 17 00:00:00 2001
From: Nick Chan <towinchenmi@gmail.com>
Date: Mon, 6 Feb 2023 16:33:14 +0800
Subject: [PATCH] organize documentation

---
 .github/workflows/build.yml   |  2 +-
 .gitignore                    |  3 ++-
 Makefile                      | 10 ++++------
 docs/Makefile                 |  9 +++++++++
 mandoc.css => docs/mandoc.css |  0
 palera1n.1 => docs/palera1n.1 |  0
 6 files changed, 16 insertions(+), 8 deletions(-)
 create mode 100644 docs/Makefile
 rename mandoc.css => docs/mandoc.css (100%)
 rename palera1n.1 => docs/palera1n.1 (100%)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index d67eb26..4a8151f 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -21,7 +21,7 @@ jobs:
         run: |
           make -j$(nproc) docs
           mkdir ready
-          cp palera1n.1.html mandoc.css ready
+          cp docs/*.html docs/mandoc.css ready
 
       - name: Upload artifact
         uses: wangyucode/sftp-upload-action@v1.4.8
diff --git a/.gitignore b/.gitignore
index a8369de..26e5f96 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,7 +8,6 @@ contrib/
 checkra1n*
 payload.c
 src/palera1n
-palera1n*
 !xxd-embedded.h
 src/binpack.dmg
 src/ramdisk.dmg
@@ -16,3 +15,5 @@ src/xxd-*.c
 .DS_Store
 !palera1n.1
 palera1n.1.html
+Payload
+docs/*.html
diff --git a/Makefile b/Makefile
index 8f06a03..a10fdeb 100644
--- a/Makefile
+++ b/Makefile
@@ -54,18 +54,16 @@ palera1n: download-deps
 
 clean:
 	$(MAKE) -C src clean
-	rm palera1n.1.html
+	$(MAKE) -C docs clean
 
 download-deps:
 	$(MAKE) -C src checkra1n-macos checkra1n-linux-arm64 checkra1n-linux-armel checkra1n-linux-x86 checkra1n-linux-x86_64 checkra1n-kpf-pongo ramdisk.dmg binpack.dmg
 
-palera1n.1.html: palera1n.1
-	mandoc -T html -O style=mandoc.css palera1n.1 > palera1n.1.html
-
-docs: palera1n.1.html
+docs:
+	$(MAKE) -C docs
 
 distclean: clean
 	rm -rf palera1n-* palera1n*.dSYM src/checkra1n-* src/checkra1n-kpf-pongo src/ramdisk.dmg src/binpack.dmg
 
-.PHONY: all palera1n clean
+.PHONY: all palera1n clean docs distclean
 
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..df21369
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,9 @@
+PAGES = palera1n.1.html
+
+all: $(PAGES)
+
+%.1.html: %.1
+	mandoc -T html -O style=mandoc.css palera1n.1 > palera1n.1.html
+
+clean:
+	rm -f $(PAGES)
diff --git a/mandoc.css b/docs/mandoc.css
similarity index 100%
rename from mandoc.css
rename to docs/mandoc.css
diff --git a/palera1n.1 b/docs/palera1n.1
similarity index 100%
rename from palera1n.1
rename to docs/palera1n.1