documentationNotes.txt

Quick Mserve documentation and examples review

1. The top level README needs major cleanup, and a more focused purpose.
2. The "match" dispatch algorithm should probably not be the default,
 and in particular should not be used for examples 1-3.
2.1. It does not process queries in the order they arrive, they must wait for a free matching servant.
2.2. It performs poorly when the number of servants less than the number of distinct routes.
2.3  It emits console messages like (match;6i;7i) (claim;6i;7i) (wait;6i;7i) which will just be confusing.
2.4. There is no locality of reference to be gained in our example routing on the first argument (symbol).
2.5. I prefer the original algo as the default.. I am not sure what to do with the "even" algo.
2.6. The match and even algorithm was all created for batchmark experiments involving an hdb and were driven 
     mostly by seeking cache-warmness; without that context they don't make much sense.
3. 01quickstart is just about getting new user over hump of seeing their first result,
   and to understand the flow of data between the components. If it only used one servant it would not
   matter which dispatch algo was used, but in step 4 it asks the user to run with 5 servants, but does
   elaborate further. The mserve console messages are not discussed.
4. 02quickauth introduces secure_invocation, the plugin archetecture, and shows how auth/auth may be implemented.
5.