TiddlyWiki / TiddlyWikiClassic

TiddlyWiki Classic (not to be confused with TiddlyWiki5: https://github.com/Jermolene/TiddlyWiki5)
https://classic.tiddlywiki.com/
492 stars 114 forks source link

Update Contribute.tid #242

Closed markkerrigan closed 5 years ago

markkerrigan commented 5 years ago
YakovL commented 5 years ago

Thanks, this is helpful, too! (good idea about Translations, now the link to it is not duplicated which is also nice) Are you going to create the Documentation tiddler soon? Should I wait until then before merging? If so, I think it will be proper to create it in this branch, too

Some side notes:

markkerrigan commented 5 years ago

I took a stab at creating a Documentation tiddler and it's merged into the this PR. It's all making sense putting multiple files into a single PR. :)

I put some questions / comments in the notes for Documentation.tid. Tried to keep a brief history of the documentation and provide a way to link to the TiddlySpace backups.

YakovL commented 5 years ago

Hi Mark, great, nice ground to build content on it; I have several suggestions which I've implemented in the text on the bottom of this message (I suppose Contribute.tid is good enough now and the suggestions are regarding Documentation):

Documentation for ~TiddlyWiki Classic is maintained [[here|https://classic.tiddlywiki.com]]. Content tiddlers are stored [[in the core Github repository|https://github.com/TiddlyWiki/TiddlyWiki/tree/master/content]] as separate files and are merged into single TW (this site) with the [[build tools|https://github.com/TiddlyWiki/tiddlywiki.com]].

!Contributing
Documentation always needs updates and improvements, and contributions are welcome. Technically, you can participate via GitHub's pull requests. Feel free to propose changes; to learn more about best practices and specific needs, please ask at the [[community forum|DiscussionForums]].

!History and other documentation
Previously documentation was maintained in a ~MediaWiki instance hosted by Osmosoft at tiddlywiki.org. [[In 2011|https://groups.google.com/forum/?fromgroups#!topic/tiddlywiki/wAW1pQABu8k]], the content was migrated to a ~TiddlySpace known as the Community Documentation. A separate DeveloperDocumentation was also hosted on TiddlySpace. [[In 2016|https://groups.google.com/forum/#!topic/tiddlyspace/gDqcOXvpiZc]] with ~TiddlySpace discontinued, the Community Documentation and DeveloperDocumentation are no longer actively maintained.

There's also a number of other [[tutorials and guides|TutorialsAndGuides]] created by other ~TiddlyWiki users.

Many seemingly gone docs and other resources in ~TiddlyWikis are in fact available via [[Web Archive|http://web.archive.org/]], for instance [[Community Documentation|http://web.archive.org/web/20161211153445/http://tiddlywiki.tiddlyspace.com/]] and [[Developer Documentation|http://web.archive.org/web/20160810230802/http://tiddlywikidev.tiddlyspace.com/]]

If you think this is good enough, let's make a final commit and I'll merge the whole thing into master and update the site :)

There is one thing about this version of Documentation.tid which I don't like: lack of a link that will help a person who is not familiar with github to learn how to fork-edit-create PR. What do you think about it? How did you figured your way through this? Does this or this look helpful?

There are definitely more things to improve, but I think those can be done in later PRs.

YakovL commented 5 years ago

Thanks! Merged this one.

A summary of noticed things that may deserve handling in the future:

YakovL commented 5 years ago

PS reviewed my plan of site updating, was delighted to note that several first steps are covered with the changes we've done recently :)