chat.sr.ht: initial docs

1 files changed, 55 insertions, 0 deletions

diff --git a/chat.sr.ht/index.md b/chat.sr.ht/index.md
new file mode 100644
index 0000000..9df4021
--- /dev/null
+++ b/chat.sr.ht/index.md
@@ -0,0 +1,55 @@
+# chat.sr.ht
+
+chat.sr.ht provides real-time chat services to sourcehut users based on the
+Internet Relay Chat ([IRC][0]) protocol. In technical terms, chat.sr.ht
+essentially provides a hosted IRC bouncer for paid users, and a web gateway for
+other users.
+
+**NOTICE**: chat.sr.ht is currently in a closed beta. Reach out to emersion on
+libera.chat for details.
+
+SourceHut does not operate an IRC network. We recommend [Libera Chat][1], an
+independently operated, third-party network, which chat.sr.ht is configured to
+use by default. Please review the Libera Chat [Network policies][2] for details
+on appropriate network usage.
+
+[0]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
+[1]: https://libera.chat
+[2]: https://libera.chat/policies
+
+## chat.sr.ht documentation
+
+To start using chat.sr.ht, simply visit [chat.sr.ht](https://chat.sr.ht) in your
+web browser and log in with your SourceHut credentials. Read the instructions
+on-screen to get started.
+
+We have a few additional guides for different audiences:
+
+- [Quick-start for experienced IRC users](/chat.sr.ht/quickstart.md)
+- [Using the IRC bouncer](/chat.sr.ht/bouncer-usage.md)
+- [Setting up an IRC channel for your project](#TODO)
+- [Writing an IRC bot](#TODO)
+- [Information for network operators](#TODO)
+
+## chat.sr.ht software
+
+chat.sr.ht is based on the [soju][3] IRC bouncer and the [gamja][4] webchat
+client. Our downstream patches, if any, are kept in the "srht" branch of each.
+
+[3]: https://soju.im/
+[4]: https://sr.ht/~emersion/gamja/
+
+## Official IRC channels and support
+
+SourceHut operates a number of official IRC channels on libera.chat where you
+can get support for sr.ht issues or socialize with other SourceHut users. You
+can join them with the `/join <channel>` command.
+
+- #sr.ht: on-topic sourcehut support and development channel, including for
+  technical issues related to chat.sr.ht's webchat and bouncer service
+- #sr.ht.watercooler: off-topic channel for discussing sourcehut-adjacent topics
+  with the sourcehut community
+- #sr.ht.ops: read-only technical operations & monitoring channel
+- #liberachat: official Libera network support, for issues with channel
+  management, NickServ account maintenance, and moderation and spam concerns.
+  This channel is not officially affiliated with SourceHut.