TiddlyWiki5/editions/tw5.com/tiddlers/community/Improving TiddlyWiki Documentation.tid

created: 20140820151051019
modified: 20190115165616599
tags: Community
title: Improving TiddlyWiki Documentation
type: text/vnd.tiddlywiki

Anyone can submit improvements to the TiddlyWiki documentation that appears on https://tiddlywiki.com. (For improvements to the core code a more complicated process must be used because of the need to test the changes both in the browser and under Node.js before submission).

<<.warning """If you already know GitHub, note that documentation updates must be directed to the `tiddlywiki-com` branch""">>

# Read and observe the [[Documentation Style Guide]]
# Create an account on https://github.com if you don't already have one
# If you haven't done so already, sign the [[Contributor License Agreement]] as described in [[Signing the Contributor License Agreement]]
# On https://tiddlywiki.com, click "edit" on the tiddler you want to improve
# You should see a pink banner with the text: //Can you help us improve this documentation? Find out how to edit this tiddler on ~GitHub//
# Click on the external link ...''this tiddler on ~GitHub''
## You will be prompted that "you need to fork this repository to propose changes". A "fork" is your own copy of the repository that incorporates the changes you are proposing
# A new browser tab should open ready to edit the tiddler on github.com
# Below the edit box for the tiddler text you should see a box labelled ''Propose file change''
# Enter a brief title to explain the change (eg, "Clarify attribute syntax instability")
# If necessary, enter a longer description too
# Click the green button labelled ''Propose file change''
# On the following screen, click the green button labelled ''Create pull request''

[[Jermolene|https://github.com/Jermolene]] or one of the other core developers will then have the opportunity to merge your pull request so that it is incorporated into the next build of https://tiddlywiki.com.

Mario Pietsch has created these short video tutorials:

<iframe width="560" height="315" src="https://www.youtube.com/embed/L4zTkMYcri8" frameborder="0" allowfullscreen></iframe>

<iframe width="560" height="315" src="https://www.youtube.com/embed/6ElUruH92tc" frameborder="0" allowfullscreen></iframe>

<iframe width="560" height="315" src="https://www.youtube.com/embed/axFCk9KsMFc" frameborder="0" allowfullscreen></iframe>
Tweaks to the improvement banner I think it looks pretty terrible, and am minded not to include it in 5.0.15. Interested in other views. 2014-08-20 16:06:39 +00:00			`created: 20140820151051019`
Docs updates for TW5's new branch development model 2019-01-15 17:39:45 +00:00			`modified: 20190115165616599`
More documentation mangling 2014-09-10 21:09:44 +00:00			`tags: Community`
More docs updates 2014-09-10 21:35:02 +00:00			`title: Improving TiddlyWiki Documentation`
First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`type: text/vnd.tiddlywiki`
Tweaks to the improvement banner I think it looks pretty terrible, and am minded not to include it in 5.0.15. Interested in other views. 2014-08-20 16:06:39 +00:00
Change http://.tiddlywiki.com/ to https:// 2017-11-11 11:56:20 +00:00			`Anyone can submit improvements to the TiddlyWiki documentation that appears on https://tiddlywiki.com. (For improvements to the core code a more complicated process must be used because of the need to test the changes both in the browser and under Node.js before submission).`
Tweaks to the improvement banner I think it looks pretty terrible, and am minded not to include it in 5.0.15. Interested in other views. 2014-08-20 16:06:39 +00:00
Docs updates for TW5's new branch development model 2019-01-15 17:39:45 +00:00			<<.warning """If you already know GitHub, note that documentation updates must be directed to the `tiddlywiki-com` branch""">>

First pass at a documentation style guide Needs more detail. 2014-09-04 16:51:08 +00:00			`# Read and observe the [[Documentation Style Guide]]`
Improved documentation on improving the documentation 2014-08-20 21:07:12 +00:00			`# Create an account on https://github.com if you don't already have one`
Docs updates 2015-06-30 21:01:06 +00:00			`# If you haven't done so already, sign the [[Contributor License Agreement]] as described in [[Signing the Contributor License Agreement]]`
Change http://.tiddlywiki.com/ to https:// 2017-11-11 11:56:20 +00:00			`# On https://tiddlywiki.com, click "edit" on the tiddler you want to improve`
Extraneous wikilink in docs 2014-08-20 21:25:55 +00:00			`# You should see a pink banner with the text: //Can you help us improve this documentation? Find out how to edit this tiddler on ~GitHub//`
Improved documentation on improving the documentation 2014-08-20 21:07:12 +00:00			`# Click on the external link ...''this tiddler on ~GitHub''`
Improve GitHub explanation Trying to address #770 2014-08-30 21:53:39 +00:00			`## You will be prompted that "you need to fork this repository to propose changes". A "fork" is your own copy of the repository that incorporates the changes you are proposing`
Improved documentation on improving the documentation 2014-08-20 21:07:12 +00:00			`# A new browser tab should open ready to edit the tiddler on github.com`
			`# Below the edit box for the tiddler text you should see a box labelled ''Propose file change''`
			`# Enter a brief title to explain the change (eg, "Clarify attribute syntax instability")`
			`# If necessary, enter a longer description too`
			`# Click the green button labelled ''Propose file change''`
			`# On the following screen, click the green button labelled ''Create pull request''`

Change http://.tiddlywiki.com/ to https:// 2017-11-11 11:56:20 +00:00			`[[Jermolene\|https://github.com/Jermolene]] or one of the other core developers will then have the opportunity to merge your pull request so that it is incorporated into the next build of https://tiddlywiki.com.`
Update Improving TiddlyWiki Documentation.tid 2014-08-30 20:32:53 +00:00
Add @pmario's latest video Part of addressing #770 2014-09-01 16:02:37 +00:00			`Mario Pietsch has created these short video tutorials:`
Add @pmario's video tutorials 2014-08-31 13:43:14 +00:00
Use https for YouTube 2017-11-18 19:53:52 +00:00			`<iframe width="560" height="315" src="https://www.youtube.com/embed/L4zTkMYcri8" frameborder="0" allowfullscreen></iframe>`
Add @pmario's latest video Part of addressing #770 2014-09-01 16:02:37 +00:00
Use https for YouTube 2017-11-18 19:53:52 +00:00			`<iframe width="560" height="315" src="https://www.youtube.com/embed/6ElUruH92tc" frameborder="0" allowfullscreen></iframe>`
Add @pmario's latest video Part of addressing #770 2014-09-01 16:02:37 +00:00
Use https for YouTube 2017-11-18 19:53:52 +00:00			`<iframe width="560" height="315" src="https://www.youtube.com/embed/axFCk9KsMFc" frameborder="0" allowfullscreen></iframe>`