created: 20140820151051019 modified: 20240313114828368 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""">> ! Before you start editing # 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]] ! Editing and submitting your edits You can choose to edit the documentation using the [[TiddlyWiki Docs PR Maker]] or directly in ~GitHub. The first method is especially recommended for users not familiar with ~GitHub. !! Using [[Docs PR Maker|TiddlyWiki Docs PR Maker]] edition # Go to https://saqimtiaz.github.io/tw5-docs-pr-maker/ or click the link displayed in the ribbon underneath the title when editing a tiddler on tiddlywiki.com # Go through the quick introduction where you will need to provide your ~GitHub username and a ~GitHub access token (you will be guided in creating one) # Edit or create tiddlers to update the documentation, the wiki will keep track of all changes # Click the "Submit updates" button and check if all the tiddlers that you edited are included in the submission; if not, drag them into the box # Provide a concise title and description of your changes (see the rules about titling pull requests in [[contribution guidelines|Contributing]]) # Submit your changes: ** "Save as draft" will create a //draft// pull request, this is useful if you don't want the changes to be merged //yet//, because you want to work on it later or discuss it first ** "Submit documentation update" will create a pull request, which will be immediately available for review and merging !! Using ~GitHub # 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: