From: Joey Hess <joey@gnu.kitenet.net>
Date: Fri, 5 Jun 2009 20:33:07 +0000 (-0400)
Subject: add note about the basewiki being self contained
X-Git-Tag: 3.141~35
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9e74d600575f59456fa46df22f8be1ec411c9200;p=ikiwiki.git

add note about the basewiki being self contained
---

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.