My general thoughts about TW "reference documentation"

IMO* the only way*, we can keep a reference docs up to date is, that we 
create the reference docs within the source code and extract it 
automagically. 

Jeremy's viewpoint is, that there is enough "inline" documentation in the 
code already. ... That's probably true -- for him :)

So we can't expect him to add more. That's ok. It should be a community 
effort to add and extract what new contributors need. TW has the 
possibility built in, to extract javascript comments and transfer them into 
readable html pages or even TWs. ...

The problem here is, that it needs Jeremy to merge pull requests, which is 
very time consuming. ... So imo we need a mechanism, that allows "key 
contributors" to merge those "docs-only-PRs", without the need for Jeremy 
to "waste" his time. 

I did introduce one possible way in a hangout lately. ... But this 
mechanism has to be discussed and refined. ... Which will be one major 
topic for me in the July meetup.

The same is true for translations. Translations are 2 fold

 a) core UI text translations will always be "core" PRs
 b) Language specific editions eg: german, french, ... versions can be 
separated

Language specific landing pages, should stick to the TiddlyWiki "Corporate 
Identity" but can be completely different, depending on the target 
audience. Different countries have a different "cultural" background and 
imo a landing page should reflect this. .... 

just some thoughts
-mario



-- 
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/46e69e2c-28a7-47ef-a40c-c5a8227e3941%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to