Various minor site/documentation changes

This commit is contained in:
Ske 2019-08-31 12:32:28 +02:00
parent 9b0b8b4353
commit dbade9b6bc
9 changed files with 39 additions and 2 deletions

View File

@ -44,6 +44,17 @@ $ docker-compose up -d
* Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml`
* Run the bot: `dotnet run --project PluralKit.Bot`
# Building the docs
The website and documentation are automatically built by GitHub Pages when pushed to the `master` branch. They use [Jekyll 3](https://jekyllrb.com), which requires [Ruby](https://www.ruby-lang.org) and [Bundler](https://bundler.io/).
To build the docs locally, run:
```
$ cd docs/
$ bundle install --path vendor/bundle
$ bundle exec jekyll build
To run an auto-reloading server, substitute the last command with:
$ bundle exec jekyll serve
# License
This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0

View File

@ -2,6 +2,7 @@
layout: default
title: User Guide
permalink: /guide
description: PluralKit's user guide contains a walkthrough of the bot's features, as well as how to use them.
---
# User Guide

View File

@ -2,10 +2,11 @@
layout: default
title: Command List
permalink: /commands
description: The full list of all commands in PluralKit, and a short description of what they do.
---
# How to read this
Words in \<angle brackets> are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters.
Words in \<angle brackets> are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters. Note that **you should not include the brackets in the actual command**.
# Commands
## System commands

View File

@ -2,6 +2,7 @@
layout: default
title: API documentation
permalink: /api
description: PluralKit's API documentation.
---
# API documentation

View File

@ -2,6 +2,7 @@
layout: default
title: Privacy Policy
permalink: /privacy
description: I'm not a lawyer. I don't want to write a 50 page document no one wants to (or can) read. It's short, I promise.
---
# Privacy Policy

21
docs/5-faq.md Normal file
View File

@ -0,0 +1,21 @@
---
layout: default
title: FAQ
permalink: /faq
description: Frequently asked questions (and the answers to them).
---
# Frequently asked questions
{: .no_toc }
1. TOC
{:toc}
## Can I use this bot for kin/roleplay/other non-plurality uses? Can I use it if I'm not plural myself? Is that appropriating?
Although this bot is designed with plural systems and their use cases in mind, the bot's feature set is still useful for many other types of communities, including role-playing and otherkin. By all means go ahead and use it for those communities, too. We don't gatekeep, and neither should you.
## Who's the mascot?
[Our lovely bot mascot](https://imgur.com/a/LTqQHHL)'s name is Myriad! They were drawn by the lovely [Layl](https://twitter.com/braindemons). Yes, there are fictives.
## How can I support the bot's development?
I (the bot author, [Ske](https://twitter.com/floofstrid) have a Patreon. The income from there goes towards server hosting, domains, infrastructure, my Monster Energy addiction, et cetera. There are no benefits. There might never be any. But nevertheless, it can be found here: [https://www.patreon.com/floofstrid](https://www.patreon.com/floofstrid)

View File

@ -1,2 +1,3 @@
source "https://rubygems.org"
gem 'github-pages', group: :jekyll_plugins
gem 'wdm', '>= 0.1.0' if Gem.win_platform?

BIN
docs/assets/myriad.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 664 KiB

BIN
docs/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB