aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore3
-rw-r--r--.mrconfig12
-rw-r--r--Makefile33
-rw-r--r--README.md3
-rw-r--r--mkdocs.yml19
5 files changed, 70 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ba27d5c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+docs/
+site/
+source/
diff --git a/.mrconfig b/.mrconfig
new file mode 100644
index 0000000..d3478bf
--- /dev/null
+++ b/.mrconfig
@@ -0,0 +1,12 @@
+
+[source/account]
+checkout = git clone 'https://source.virtual-assembly.org/feature/account.git' 'account'
+
+[source/account-shell]
+checkout = git clone 'https://source.virtual-assembly.org/feature/account-shell.git' 'account-shell'
+
+[source/chat]
+checkout = git clone 'https://source.virtual-assembly.org/feature/chat.git' 'chat'
+
+[source/source]
+checkout = git clone 'https://source.redpill.dk/source.git' 'source'
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..40d4bce
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,33 @@
+# Depends: myrepos git mkdocs linkchecker
+
+all: doc
+
+doc: docs $(patsubst %,docs/%,$(subst -,/,$(notdir $(wildcard source/*))))
+ mkdocs build --strict
+ linkchecker site/index.html
+
+docs:
+ mkdir -p docs
+ ln -sf ../README.md docs/index.md
+# ln -sf ../USE.md docs/use.md
+# ln -sf ../ADMIN.md docs/admin.md
+
+docs/%: source
+ mkdir -p docs/$*
+ ln -sf $(shell realpath --relative-to=$@ source/$(subst /,-,$*)/README.md) docs/$*/index.md
+ $(if $(wildcard source/$(subst /,-,$*)/USE.md),\
+ ln -sf $(shell realpath --relative-to=$@ source/$(subst /,-,$*)/USE.md) docs/$*/use.md)
+ $(if $(wildcard source/$(subst /,-,$*)/ADMIN.md),\
+ ln -sf $(shell realpath --relative-to=$@ source/$(subst /,-,$*)/ADMIN.md) docs/$*/admin.md)
+
+init:
+ mr update
+
+clean:
+ rm -rf site
+ rm -rf docs
+
+distclean: clean
+ rm -rf source
+
+.PHONY: all doc clean distclean
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75299dc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+# System features
+
+This is documentation for system features at [[org Virtual Assembly]].
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..e8451e7
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,19 @@
+site_name: System features
+nav:
+- Features:
+ - Introduction: 'index.md'
+ - Account: 'account/index.md'
+ - 'Account shell': 'account/shell/index.md'
+ - Chat: 'chat/index.md'
+ - Source: 'source/index.md'
+- Use:
+# - Introduction: 'use.md'
+# - Account: 'account/use.md'
+ - 'Account shell': 'account/shell/use.md'
+ - Chat: 'chat/use.md'
+ - Source: 'source/use.md'
+- Administration:
+# - Introduction: 'admin.md'
+ - Account: 'account/admin.md'
+ - 'Account shell': 'account/shell/admin.md'
+# - Chat: 'chat/admin.md'