I am thinking this is actually an area where we *definitely* should "eat 
our own dogfood".

In other words: find a way to parse and transform modules / code / comments 
and output everything *into a TiddlyWiki* with proper fields / tags / 
presentation / plugins.

*Imagine* this as a node package other package distributors can use to 
generate the same type documentation by the click of a button, provided the 
same commenting rules are parseable.

This makes me think: Should code-comments actually be in the format of 
*.tid* files? This would make parsing enormously straight forward.

All we needed was some conventions on how to populate which (standard) 
fields, tags, text-templates with content. Perhaps some helper macros to 
cross-reference.

Doc-tiddlers would be without any *$:/* prefix, simply showing 
documentation and the actual code being documented right below (from the 
shadow tiddler).

If we wanted to, we could develop a custom theme to show documentation and 
code side-by-side. After all, we know what line of a file some 
documentation block refers to.

As for non-js files and folders, there could be complementary *.tid* files 
as the documentation counterpart.

Best wishes, Tobias.

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWikiDev" 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 http://groups.google.com/group/tiddlywikidev.
For more options, visit https://groups.google.com/d/optout.

Reply via email to