docs: update babyrite documentation (#194)

m1sk9 · Aug 23, 2024 · 651c328 · 651c328
1 parent 0b28ec8
commit 651c328
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 4 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -4,10 +4,12 @@
 
 [Installation](./installation.md)
 
-[Usage](./usage.md)
-
 [Configuration](./configuration.md)
 
 [Hosted babyrite](./hosted.md)
 
+[Usage](./usage.md)
+
+[FAQ](./faq.md)
+
 [Changelog](./changelog.md)
diff --git a/docs/src/changelog.md b/docs/src/changelog.md
@@ -1,5 +1,7 @@
 # Changelog
 
+Updates are available for major versions only.
+
 The full version should be checked on [GitHub](https://github.com/m1sk9/babyrite/releases).
 
 ----

diff --git a/docs/src/faq.md b/docs/src/faq.md
@@ -0,0 +1,23 @@
+# FAQ
+
+<!-- toc -->
+
+### Can babyrite be operated with [Sharding](https://discord.com/developers/docs/topics/gateway#sharding)?
+
+No, it cannot. babyrite does not support operation with multiple processes using Sharding. Therefore, it is not recommended to operate in more than 2500 guilds.
+
+If you wish to operate in this manner, you should either create your own bot instead of using babyrite, or use a publicly available bot.
+
+### Why is Windows not supported?
+
+Strictly speaking, it is untested. babyrite has been tested for compilation and execution on macOS (`aarch64-apple-darwin`), which is used by the developer, and on Debian (`x86_64-unknown-linux-gnu`), used in the Docker Image. These are the supported OS architectures.
+
+Windows is untested due to reasons like excessively long GitHub Actions execution times. Therefore, it is considered an unsupported OS, and there are no plans to support it in the future.
+
+### Can babyrite be used with Shuttle?
+
+No, it cannot be used. There are no plans to release a compatible version.
+
+### Can I quote poll messages?
+
+As of [v0.9.0](./changelog.md#v090), quoting poll messages is not possible because Serenity does not support it.
diff --git a/docs/src/hosted.md b/docs/src/hosted.md
@@ -31,7 +31,7 @@ babyrite is a dynamically linked binary compiled with Rust. Unlike discord.js an
 - 1 CPU core
 - 512MB RAM
 
-Supports only **Linux and macOS**. (Windows is not **support**ed)
+Supports only **Linux and macOS**. [(Windows is not **support**ed)](./faq.md#why-is-windows-not-supported)
 
 > [!NOTE]
 > 

diff --git a/docs/src/overview.md b/docs/src/overview.md
@@ -11,7 +11,7 @@ There are several such bots in the public, but none of them have been released a
 
 ## Navigation
 
-- [Setup 🛠️](./setup.md)
+- [Installation 🛠️](./installation.md)
 - [Sponsor this project ❤️](https://github.com/sponsors/m1sk9)
 - [Packages 📦](https://github.com/m1sk9/babyrite/pkgs/container/babyrite)
 - [Repository 🐱](https://github.com/m1sk9/babyrite)