Request for Help: Documentation/Demo/Working Examples

Is anybody who has been following that thread able to easily summarize the current state of the initiative in 30 seconds for us? I tried to catch up on it the other day, but the thread had 61 posts, and after reading for upwards of 5 minutes I still had no idea where it was currently at, so I gave up :slight_smile: .

A few suggestions to start out:

  1. Most importantly, I have never seen this documentation before, and I’ve actively tried to find it. We maybe have a general problem with organization on tiddlywiki.com, but also the place I look for information on contributing is on GitHub, not on the project’s user documentation site. For instance, there is a “Documentation” section in the “Community” section of the project README, which doesn’t say anything about this.

  2. The section on documentation macros has no examples, so I don’t really understand where/how they are to be used. I don’t remember seeing most of these used when I randomly pop into edit mode throughout TW-com either, so if they are only used some of the time and the goal is to eventually get them used in more places, it would be nice to mention that.

  3. It would be nice to have a clear list of things that we know need work so that new contributors know where to get started.

  4. An explanation of the review/merge process, added to the section on “Improving TiddlyWiki Documentation”, would be helpful, especially for those who have never used GitHub.

  5. If we want to encourage people to make bold changes, wiki-style, we should say that in the style guide or contributing guide. If there are caveats to that, or things that should be left for backwards compatibility, or whatever, that should be explained too. One of the biggest obstacles to me is that I have no idea what the community thinks is up for grabs when improving the docs and what’s better left alone. Either I have to ask a bunch of questions or risk spending a bunch of time doing something that proves to be useless.

Side note, have we considered displaying a list of sub-items (the tagged tiddlers) at the bottom of each tiddler (or somewhere else convenient) in the docs, if there are any? For instance “Improving TiddlyWiki Documentation” has a bunch of tiddlers below it, but unless you’re poking around in the TOC or go into the “Tagging” tab of the info screen, you have no way of knowing.