From 6c7bb94e951bbf0095cfa127e3e7dabe9449bac1 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Thu, 11 Aug 2022 10:56:11 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- pwiki2.js | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/pwiki2.js b/pwiki2.js index b2c235c..df563a7 100755 --- a/pwiki2.js +++ b/pwiki2.js @@ -88,6 +88,25 @@ * use of high level libs like types... * * +* XXX DOC: +* - paths in pWiki behave a bit differently than traditional +* file-system paths, this is due to one key distinction: +* in pWiki there is no distinction between a file and a +* directory +* i.e. each path can both contain data as a file and at the same +* time support sub-paths etc. +* for this reason behaviour of some APIs will differ, all paths +* within a page (a-la file) are relative to its children and not +* to it's siblings. For example, for page "/a/b/c" a link to "./x" +* will resolve to "/a/b/c/x" and this is independent of whether +* the base path is given as "/a/b/c/" or "/a/b/c" +* +* NOTE: implementing things in a traditional manner would +* introduce lots of edge-cases and subtle ways to make +* mistakes, bugs and inconsistencies. +* - +* +* * XXX weaknesses to review: * - .paths() as an index... * + decouples the search logic from the store backend