Skip to content

RTFM Home

RTFM is SYN Shop's documentation for common usage at SYN Shop. You can read it for information about equipment, tutorials, or resources.

If there are improvements you'd like to see, message the #rtfm channel on discord or create an issue on github. 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 - listings of equipment and how to use them.
  • Software - (Work In Progress) listings and usage of software relevant to the shop.
  • Projects - start your own project or get involved with group projects in this section.
  • Resources - places to source materials both local and online.

Contributing to RTFM

It's encouraged to contribute to RTFM to help improve RTFM's organization and availability of information.

What help do we need?

Here are some common ways you can help rtfm:

  • Filling STUB articles with more information.

  • Improve the style of pages so it conforms to the Manual of Style. This can include:

    • Fixing spelling or grammar errors.
    • Rewriting pages so that they share the same structure as other pages.
    • Add tags to the front matter of an article.
    • Improving reading flow with the use of admonitions, grids, or tabs.

How do I get involved?

There are 4 ways to get engaged with SYN Shop RTFM: