This comment is strictly in the context of developing using the javascript 
portions of tiddlywiki. This would be a developers tool, not a users guide.

For the code it isn't that there isn't enough documentation for the core, 
but that it isn't easily searchable. At a minimum I would like a function 
reference. I keep finding myself having to search through a bunch of core 
files to find the definition for something like getTextReference, so even a 
list like I already have that lets you search for a function and see what 
file it is in will save me a lot of time. Documentation or examples on top 
of that will hopefully be useful for lowering the barriers to entry for new 
people.

I would like, even as just an experiment, to cut up the code so each 
function has its own tiddler and then use templates to build the source 
code. I think that there could be many benefits to usability by doing this, 
like making it easy to search, helping reduce redundant code and allowing 
much more complete documentation along with the code itself. Last time I 
tried starting this Jeremy had brought up a similar project he had 
attempted a while ago, so I know I am not the only one with the idea. I am 
sure there will be plenty of problems and we would need to build new tools 
to make it work.

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/tiddlywiki.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/0002c4bc-efee-4ec8-ade0-64cf4b643606%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to