On Friday, April 1, 2022 at 2:24:30 PM UTC+2 [email protected] wrote:

> Yes, I know that.  I'm not asking for myself.  My point is that it should 
> be easy for anybody to learn about all TiddlyWiki features involved in any 
> example in the documentation. 
>
 ....

> It is sad and disappointing that TiddlyWiki features are being used in the 
> documentation, but the very usage not documented.  Lost opportunities.
>

OK. So a little bit of info for those, who want directly contribute to the 
TW docs. 

You are right. ... Documenting "the documentation" is an option, to show 
users what's possible. I think the needs of the TW docs are very specific. 
But still -- one can learn a lot from it. 

We -- the core devs -- need help from the community if that "meta" content 
should be there. 

There is a lot of work to do for the reference documentation. Detailed 
documentation "how the doc macros work" will add to the existing work that 
"should be already done" ... 

The TW documentation is a community effort and everyone is welcome to 
create content and contribute it. 

I did create a HowTo: 7 Steps to improve the tiddlywiki documentation 
<https://talk.tiddlywiki.org/t/7-steps-to-improve-the-tiddlywiki-documentation/2590>
 
at "Talk TiddlyWiki". I also did create a video series, that shows how to 
use it. The link to the videos can be found at the HowTo. 

Discussion and feedback can happen at Talk 
<https://talk.tiddlywiki.org/t/discussion-7-steps-to-improve-the-tiddlywiki-documentation/2909>
 
too.

Saq, did create a "working prototype" Wiki that is online, can be modified 
and can create contributions, that can directly be implemented into the 
"living" docs at tiddlywiki.com. (Link in the HowTo)

There is a Documentation Styleguide 
<https://tiddlywiki.com/#Documentation%20Style%20Guide> and an overview 
about the Documentation macros 
<https://tiddlywiki.com/#Documentation%20Macros> at tiddlywiki.com .. (By 
the way, I'm talking about those elements in the Video mentioned in the 
HowTo.) 

Contributions to the documentation can be successful, if users loosely 
follow the style-guide. Nothing can be broken. It may take several 
iterations till something can be accepted. 

So everyone, that wants to help us to improve the docs, so we don't loose 
opportunities can have a closer look at: 7 Steps to improve the tiddlywiki 
documentation 
<https://talk.tiddlywiki.org/t/7-steps-to-improve-the-tiddlywiki-documentation/2590>
 

Have fun!
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 view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/c660a2d3-42fd-4f30-861e-650ca51389ecn%40googlegroups.com.

Reply via email to