aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-06-05 16:33:07 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-06-05 16:33:07 -0400
commit9e74d600575f59456fa46df22f8be1ec411c9200 (patch)
tree4579a31d6016809fd6f836dda66653532d47908d
parentdf20a91bc9efe48cb96ecb7efd39643a816dd489 (diff)
downloadikiwiki-9e74d600575f59456fa46df22f8be1ec411c9200.tar
ikiwiki-9e74d600575f59456fa46df22f8be1ec411c9200.tar.gz
add note about the basewiki being self contained
-rw-r--r--doc/basewiki.mdwn6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/basewiki.mdwn b/doc/basewiki.mdwn
index c61ae3dba..8392884eb 100644
--- a/doc/basewiki.mdwn
+++ b/doc/basewiki.mdwn
@@ -18,3 +18,9 @@ It currently includes these pages:
As well as a few other files, like [[favicon.ico]], [[local.css]],
[[style.css]], and some icons.
+
+Note that an important property of the basewiki is that it should be
+self-contained. That means that the pages listed above cannot link
+to pages outside the basewiki. Ikiwiki's test suite checks that the
+basewiki is self-contained, and from time to time links have to be
+removed (or replaced with `iki` [[shortcuts]]) to keep this invariant.