Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MElemental authored Sep 30, 2024
1 parent 8fe7d54 commit 3330b9f
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ description: The documentation for SYN Shop.

# SYN Shop Docs

RTFM is SYN Shop's documentation for all member's usage of the shop.
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'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 there are improvements you'd like to see, message the #rtfm channel on [discord](https://synshop.org/discord) or create 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!

Expand All @@ -22,13 +22,26 @@ The main points of interest are:

## 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.
It's encouraged to contribute to RTFM to help improve RTFM's organization and availability of information.

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)
### What help do we need?
Here are some common ways you can help rtfm:

If you do 3 or 4 consider adding more information to one of the [STUB Articles](https://rtfm.synshop.org/tags/#stub).
To get an idea of what and how to improve the site, or how to use markdown check out our [Manual of Style](editors).
* Filling [STUB articles](https://rtfm.synshop.org/tags/#stub) with more information.

* Improve the style of pages so it conforms to the [Manual of Style](editors). This can include:

* Fixing spelling or grammar errors.
* Rewriting pages so that they share the [same structure](editors/Styles/Articles) as other pages.
* Add tags to the front matter of an article.
* Improving reading flow with the use of [admonitions](editors/Style/Admonitions), [grids](https://squidfunk.github.io/mkdocs-material/reference/grids/), or [tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/).

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

* Message the #rtfm channel on discord to discuss various improvements. Discord link at https://synshop.org/discord

* Create an [issue on github](https://github.com/synshop/rtfm/issues/new).

* Fork https://github.com/synshop/rtfm and make a pull request.

* Ask an RTFM admin for contributor access and contribute directly on github. (members only)

0 comments on commit 3330b9f

Please sign in to comment.