Wiki Contribution Guide

Wiki Contribution Guide

Table of Contents

• Getting Started
• Creating a New Page
  • Step 1: Navigate to the Wiki
  • Step 2: Name Your Page
  • Step 3: Format Your Content
  • Step 4: Updating the Sidebar
• Content Standards
  • Images
  • Links
  • Code Blocks
• 3D Printer Info
• Need Help?

Getting Started

1. Make a GitHub Account
2. Ask an officer to add your GitHub username to the UTSARobotics GitHub organization
3. Go to https://github.com/UTSARobotics and accept the invite
4. Log in and make an update https://github.com/UTSARobotics/Knowledge/wiki
5. (For help with the formatting, check out the GitHub Markdown Guide)

Creating a New Page

Step 1: Navigate to the Wiki

Go to the UTSARobotics Knowledge Wiki and click on the "New Page" button in the upper right corner.

Step 2: Name Your Page

• Use a clear, descriptive title
• For 3D printer information pages, use the format: Printer Info - {printer name}
• For guides, use a descriptive title that indicates the purpose (e.g., Onshape Quick Start Guide)
• Use hyphens (-) instead of spaces in the page URL

Step 3: Format Your Content

Follow the formatting guidelines based on the type of content:

For General Pages:

# Page Title

## Introduction
Brief description of the page purpose.

## Main Content
Your content here.

### Subsections
More detailed information.

## References
Any reference materials or links.

For 3D Printer Information Pages:

# Printer Info - {Printer Name}

## Description

### Model
[Model Name](link to manufacturer page)

### Modification
Description of any modifications made to the printer.

## Software

### Recommended Slicers
List of compatible slicers with download links.

### Settings
Recommended settings for different materials.

## Maintenance
Maintenance procedures and schedule.

## Troubleshooting
Common issues and solutions.

Step 4: Updating the Sidebar

After creating your page, you'll need to update the sidebar to include a link to your new page:

1. Go to the wiki's home page
2. Click on the "Edit" button in the upper right corner
3. Find the appropriate section in the sidebar
4. Add your new page using the following format:

   * [Page Title](Page-URL)
   

5. For 3D printer pages, add under ### 3D Printing:
6. For project guides, add under the appropriate project section
7. Save your changes

Content Standards

Images

• Upload images to GitHub by dragging and dropping them into the editor
• Use descriptive filenames
• Include alt text for accessibility
• Keep image sizes reasonable (under 2MB)
• Use the following format:

  ![Alt text description](image-url)
  

Links

• Use relative links for internal wiki pages
• Use full URLs for external resources
• Format links as:

  [Link Text](URL)
  

Code Blocks

• Use triple backticks (```) to create code blocks
• Specify the language after the opening backticks for syntax highlighting
• Example:

  def hello_world():
      print("Hello UTSA Robotics!")

3D Printer Info

When adding information about 3D printers, please follow the template below and name the page as "Printer Info - {printer name}".

Example:

# Printer Info - Schnitzel

## Description

### Model
[Qidi Tech X-Plus II](https://www.3dprintersbay.com/qidi-tech-x-plus)

### Modification
Our printer has a high-temp extruder attached, this allows us to print materials such a PA-CF12.

## Software

### Qidi slicer
Qidi tech offers a slicer software for Windows []()

### Orca slicer
You can use the [Orca slicer](https://github.com/SoftFever/OrcaSlicer) on both Windows and Ubuntu based OS.
Make sure you download the Orca slicer from Github, other sites may have malicious software.

For the printer selection, you can select the X-Plus 1 version as seen in the image below:

![2025-03-16_17-35](https://github.com/user-attachments/assets/c7cf4c5b-b4f7-4b14-b44c-5462c3027c4b)

Need Help?

If you encounter any issues while contributing to the wiki, please reach out to the club officers or post in the on our Discord server.