7 Steps to Improve the TiddlyWiki Documentation

This post explains how you can improve TiddlyWiki Documentation (available on http://tiddlywiki.com/) by submitting change proposal directly from a TiddlyWiki.

You find here a 7 steps detailed how to.
Step1, Step2 and Step3 have only to be done once.
You then repeat step 4 to 7 for each change proposal.

Step 1: Create a GitHub account

If you have no account to: Join GitHub · GitHub
otherwise go to your Github login

There is a video, which shows you how to create a GH account (video)


Step 2 Sign the CLA

Read and sign the TiddlyWiki Contributor License Agreement:

Details shown at: 02 Sign TW CLA using GitHub Web UI - YouTube


Step 3 Create a PAT (Personal Access Token)

Create a GitHub Personal Access Token.
Details shown at: 04 Create GitHub Personal Access Token - YouTube


Step 4 & Step5: Prepare and Backup

Details can be found at: 05 Create a PR 6487 Using TiddlyWiki pr-maker Wiki - YouTube

Preparation … for a test. See Target Repository dropdown

Backup


Step 6: Create a Pull Request

Details can be found at: 05 Create a PR 6487 Using TiddlyWiki pr-maker Wiki - YouTube


Step 7: Check the PR

Going to Pull requests · twlinks-ci-test/TiddlyWiki5 (github.com) will lead you to the TEST repository.


Important

Also have a look at TiddlyWiki Styleguide, because it will improve the chances for a successful contribution.

Learn more about the style guide from my point of view at: 07 TW Style Guide and Doc Macros - YouTube

If you are OK with the workflow go to Step4 & 5 and change the Target Repository to “Official TW Repository”

Have fun! – with a lot of pull requests to the documentation that have a chance to be active in a short period of time.

11 Likes

16 posts were split to a new topic: Discussion: 7 Steps to Improve the TiddlyWiki Documentation

This wiki can be discussed at: Discussion: 7 Steps to Improve the TiddlyWiki Documentation