dev.WikiConventions - tooll3/t3 GitHub Wiki

Contributing to the Wiki

This page details the best practices on how to improve Tooll's documentation on the wiki.

Guidelines

Wiki pages should follow the following guidelines:

  • Page names should start follow this convention: dev.PascalScale.md (Please don't use hyphens "-").
  • Before creating new pages, please make sure a page covering a similar topic doesn't already exist.
  • Please don't create pages describing operators (see Designing Operators for more info).
  • Avoid html formatting such as <br> unless necessary.

Use a proper editor

Working on the github website is okay for quick fixes, but for better ease of use, you should download the wiki and use Visual Studio Code. It has an awesome inline editor that also allows linking between pages:

Animation

To do so:

  1. In the wiki, click the Copy icon under "Clone this wiki locally"

image

  1. Open a git-interface like Fork

  2. Clone the repository (In Fork Ctrl+N)

  3. Select a target folder

  4. Clone

  5. Open Visual Studio Code

  6. File → Open Folder

  7. Open a file

  8. Toggle the preview icon to see a preview:

image