Contributing

This guide explains how to contribute to the TCAT Wiki.

Note that, while external contributions are welcome, this guide is primarily intended for use by TCAT/GS staff.

For a list of all guides on the TCAT Wiki, refer to the Guides List.

---

Full Installation and Setup (Windows 10/11)

This section of the guide explains how to set up a Windows environment for contributing to the TCAT Wiki.

Legend

1. Keyboard shortcut to press | Action

(Shift+C) | Copy

1. Command to enter into terminal

[someCommand --arguments \<path>]

Prerequisites

1. Install Visual Studio Code

2. Install YAML plugin

3. Install Markdown All in One plugin

4. Install mkdocs-material

5. In Powershell terminal:

   [pip install mkdocs-material]

6. Install image processing dependencies

7. In Powershell terminal:

   [pip install "mkdocs-material[imaging]"]

8. Install MSYS2

   1. In UCRT64 terminal:

      1. Install cairo:

         [pacman -S mingw-w64-ucrt-x86_64-cairo]

      2. Install pngquant:

         [pacman -S mingw-w64-ucrt-x86_64-pngquant]

   2. Add to PATH:

      [C:\msys64\ucrt64\bin]

Setup

1. Using VS Code, clone [https://github.com/TaskarCenterAtUW/tcat-wiki]

Editing Instructions

Refer to the documentation for Material for MkDocs and the MkDocs User Guide.