added descriptions to articles, updated main index

synshop · Sep 28, 2024 · eade094 · eade094
1 parent 3e6328b
commit eade094
Show file tree

Hide file tree

Showing 23 changed files with 132 additions and 20 deletions.
diff --git a/docs/Equipment/3D Printing/F400-s.md b/docs/Equipment/3D Printing/F400-s.md
@@ -1,5 +1,13 @@
+---
+description: NEEDS WORK A large 3D printer with an enclosure.
+tags:
+    - STUB
+    - equipment
+    - 3d printing
+    - fdm
+---
 # Fusion 3 F400-s
 
 ## Current Status
 
-### Maintenance Log
+### Maintenance Log
diff --git a/docs/Equipment/3D Printing/Resin Printers.md b/docs/Equipment/3D Printing/Resin Printers.md
@@ -1,3 +1,11 @@
+---
+description: Printers that print via stereolithography.
+tags:
+    - STUB
+    - equipment
+    - 3d printing
+    - resin
+---
 # Resin Printers
 
 _While our Resin Printers are of various makes and models, fundamentally they are similar when using them, minus a few exceptions called out below where relevant._

diff --git a/docs/Equipment/3D Printing/index.md b/docs/Equipment/3D Printing/index.md
@@ -1,3 +1,9 @@
+---
+description: A listing of SYN Shop's 3D Printing equipment.
+tags:
+    - equipment
+    - 3d printing
+---
 # 3D Printing
 ## About
 ## Activities

diff --git a/docs/Equipment/Crafts/Industrial Sewing Maching.md b/docs/Equipment/Crafts/Industrial Sewing Maching.md
@@ -1,4 +1,5 @@
 ---
+description: A heavy duty sewing machine capable of sewing leather.
 tags:
     - equipment
     - crafts

diff --git a/docs/Equipment/Crafts/Vinyl Cutter.md b/docs/Equipment/Crafts/Vinyl Cutter.md
@@ -1,18 +1,21 @@
 ---
+description: A 2 axis CNC cutter for paper and vinyl. 
 tags:
+    - STUB
     - equipment
     - vinyl
     - cutting
+    - cnc
 ---
 
 # Silhoutte Cameo 
 
 The Cameo is located in the Crafts room on the file cabinet next to the rack, and its cabling and accesories are in the drawer labelled 'Silhouette Accessories'.
 
-#Setup
+### Setup
 
 The Cameo can run in two modes, direct connect via USB, or off of a SD card.  The power cable needs to be connected in either case, but the usb cable only needs to be connected if you are going to drive it directly with your own computer. A variety of materials can be run through the Cameo, some are loaded on their own, such as vinyl, and others, such as paper or cardstock require the self adhesive cutting mat.  To use the cutting mat, remove the protective paper and press your material onto the adhesive, then load the cutting mat.  There are both pens to draw with, and blades to cut with that are to be loaded into the carrier arm.  Which you use will be up to your project, and the Studio software will provide the correct blade settings based on your material. For either, turn the lock to the left to open, insert the pen or blade, and turn the lock right to close. Do not overturn! Its simply tension with plastic, and very easy to turn past the stop.
 
-# Silhoutte Studio
+### Silhoutte Studio
 
 Studio is the software needed to generate a file to put on an SD card, or to drive the Cameo via USB.  It is available for free at [Silhouette Software](https://www.silhouetteamerica.com/software). You can import existing graphics into the program and use the Trace feature to generate cut lines, or you can create art in software itself.  There is also a link to their design store, where many predesigned files and elements can be purchased for a few dollars. From the software, you can run the Cameo via USB direct connect by choosing 'Send, or, if you want to run off an SD card, save your design as a .GSP file.
diff --git a/docs/Equipment/Crafts/index.md b/docs/Equipment/Crafts/index.md
@@ -1,3 +1,11 @@
+---
+description: A listing of SYN Shop's Craft tools and equipment.
+tags:
+    - equipment
+    - arts and crafts
+    - crafts
+---
+
 # Crafts
 
 ## About

diff --git a/docs/Equipment/Danger Room/index.md b/docs/Equipment/Danger Room/index.md
@@ -1,3 +1,11 @@
+--- 
+description: A listing of SYN Shop's wood and metalworking tools.
+tags:
+    - equipment
+    - danger room
+    - woodworking
+    - metalworking
+---
 # Danger Room
 
 ## About

diff --git a/docs/Equipment/Electronics/index.md b/docs/Equipment/Electronics/index.md
@@ -1,3 +1,9 @@
+--- 
+description: A listing of SYN Shop's electronics equipment.
+tags: 
+    - equipment
+    - electronics
+---
 # Electronics
 
 ## About

diff --git a/docs/Equipment/Laser Cutting/index.md b/docs/Equipment/Laser Cutting/index.md
@@ -1,3 +1,9 @@
+---
+description: A listing of SYN Shop's laser cutting equipment.
+tags:
+    - equipment
+    - laser cutting
+---
 # Laser Cutting
 
 

diff --git a/docs/Equipment/Print and Office/Garment Printer.md b/docs/Equipment/Print and Office/Garment Printer.md
@@ -1,4 +1,5 @@
 ---
+description: An A4 size printer for printing on shirts, totes, and other fabrics.
 tags:
   - STUB
   - equipment

diff --git a/docs/Equipment/Print and Office/Large Format Laminator.md b/docs/Equipment/Print and Office/Large Format Laminator.md
@@ -1,4 +1,5 @@
 ---
+description: A 27 inch hot laminator for laminating NON-METALIC media and ink. NO METAL EVER
 tags:
  - equipment
  - print and office

diff --git a/docs/Equipment/Print and Office/Multi-Function Printer.md b/docs/Equipment/Print and Office/Multi-Function Printer.md
@@ -1,4 +1,5 @@
 ---
+description: A full color office printer, copier and scanner.
 tags:
     - equipment
 ---

diff --git a/docs/Equipment/Print and Office/P-Touch Label Maker.md b/docs/Equipment/Print and Office/P-Touch Label Maker.md
@@ -1,13 +1,17 @@
+--- 
+description: A versatile label printer for monochromatic labels, designed in P-touch Studio.
+tags:
+    - equipment
+    - print and office
+    - labels
+---
 
 # Brother P-Touch PT-P700 Label Maker
 
-# Manuals/Software
+## Manuals/Software
 
-# Function
+## Function
 
-# Usage
-
-# Errors
-## Common Errors
-## Involved Errors
+## Usage
 
+## Troubleshooting
diff --git a/docs/Equipment/Print and Office/index.md b/docs/Equipment/Print and Office/index.md
@@ -1,3 +1,9 @@
+--- 
+description: A listing of SYN Shop's print and office equipment.
+tags:
+- equipment
+- print and office
+---
 # Print and Office
 
 ## About

diff --git a/docs/Equipment/index.md b/docs/Equipment/index.md
@@ -1,3 +1,8 @@
+--- 
+description: A simplified list of the equipment available at the shop. Moer detailed lists are availabe under each department's article.
+tags:
+    - equipment
+---
 # SYN Shop Tool & Equipment 
 
 <div class="grid cards" markdown>

diff --git a/docs/Projects/Individual/index.md b/docs/Projects/Individual/index.md
@@ -1,3 +1,6 @@
+---
+description: A list of guides and tutorials for projects that you can do at the shop.
+---
 # Individual Projects
 This section provides tutorials on projects that will use multiple pieces of equipment.
 

diff --git a/docs/Projects/Shop/RTFM.md b/docs/Projects/Shop/RTFM.md
@@ -1,10 +1,12 @@
 ---
-description: A set of objectives for RTFM
+description: A set of objectives for RTFM.
 ---
 # RTFM Rework
 RTFM is the documentation for the SYN Shop.
 It is currently being reworked in many areas described below.
 
+## Equipment List
+    The main equipment list will be summarized, and detailed lists will be provided for each department.
 ## Equipment
 Equipment pages are being standardized to provide more regular and accessible information for shop members.
 Ideally people should be able to read an equipment article and understand how it works and why they would use the equipment.

diff --git a/docs/editors/Style/Admonitions.md b/docs/editors/Style/Admonitions.md
@@ -1,3 +1,11 @@
+---
+description: Snippets of information that don't break the flow of reading.
+tags:
+    - style
+    - formatting
+    - information
+    - admonitions
+---
 # Admonitions
 For more information on admonitions see [the mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
 

diff --git a/docs/editors/Style/Articles.md b/docs/editors/Style/Articles.md
@@ -1,7 +1,9 @@
 ---
+description: RTFM guidelines on writing articles in general. Specific types of articles have their own pages.
 tags:
     - editors
     - style
+    - articles
 ---
 # Articles
 This article along with more specific articles describes the structure of specific pages. 

diff --git a/docs/editors/Style/Equipment Articles.md b/docs/editors/Style/Equipment Articles.md
@@ -1,4 +1,5 @@
 ---
+description: RTFM Guidelines on editing equipment articles. Remember it's like answering questions!
 tags:
     - editors
     - style
@@ -27,9 +28,7 @@ If the page contains multiple machines then the 1st primary heading should be th
     When filling out the contents of a template, treat each heading like you are answering someone's question about a piece of equipment.
     The following section provides questions for each heading.
 
-For new equipment entries copy equipment_template.md and rename it to the appropriate file name.
-
-A template for equipment pages is provided at:
+For new equipment entries copy [equipment_template.md](https://raw.githubusercontent.com/synshop/rtfm/refs/heads/master/docs/editors/Templates/equipment_template.md) and rename it to the appropriate file name.
 
 ### Manuals
 !!! question "Where can I get more information about this equipment?"

diff --git a/docs/editors/Style/Formatting.md b/docs/editors/Style/Formatting.md
@@ -1,4 +1,5 @@
 ---
+description: Guide on basic formatting available in RTFM.
 tags:
     - style
     - formatting
@@ -95,5 +96,5 @@ result:
 
 ## mkdocs-material Extensions
 
-### Admonitions
-### Grids
+* [Admonitions](Admonitions) - [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
+* [Grids](Grids) - [mkdocs-material documentation](https://squidfunk.github.io/mkdocs-material/reference/grids/)
diff --git a/docs/editors/Style/Software Articles.md b/docs/editors/Style/Software Articles.md
@@ -1,4 +1,5 @@
 ---
+description: RTFM Guidelines on writing articles for software.
 tags:
     - STUB
     - style

diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,31 @@
+--- 
+description: The documentation for SYN Shop.
+---
+
 # SYN Shop Docs
 
-This site houses documentation about everything and anything at the SYN Shop.  It is broken into three sections:
+RTFM is SYN Shop's documentation for all member's usage of the shop.
+You can read it for information about equipment, tutorials, or resources.
+
+If there's improvements you'd like to see, message the #rtfm channel on [discord](https://synshop.org/discord) or creating an [issue on github](https://github.com/synshop/rtfm/issues/new).
+If you're a member, consider contributing on github.
+Ask an RTFM admin for direct contributor access or get started right away and open a pull request!
+
+## Using RTFM
+
+The main points of interest are:
+
+* [Equipment](Equipment) - listings of equipment and how to use them.
+* [Software](Software) - (Work In Progress) listings and usage of software relevant to the shop.
+* [Projects](Projects) - start your own project or get involved with group projects in this section.
+* [Resources](Resources) - places to source materials both local and online.
+
+## Contributing to RTFM
+
+It's encourage to contribute to RTFM to help improve the site and the organization and availability of information.
+There are 4 ways you can contribute.
 
--  **Members:**  - These docs are for members using shop equipment and relevant software.
--  **Admins:**  - These docs are for shop members editing the RTFM site 
--  **Editors:** - These docs are for members editing RTFM.
+1. Message the #rtfm channel on discord to discuss various improvements. Discord link at https://synshop.org/discord
+2. Create an [issue on github](https://github.com/synshop/rtfm/issues/new).
+3. Fork https://github.com/synshop/rtfm and make a pull request.
+4. Ask an RTFM for contributor access and contribute directly on github. (members only)
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     ---
+    description: RTFM Guidelines on writing articles for software.
     tags:
         - STUB
         - style
@@ Expand Down @@