bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
200 stars 352 forks source link

Archive Discord #help threads in a search-indexed fashion #379

Open alice-i-cecile opened 2 years ago

alice-i-cecile commented 2 years ago

Discord help threads are ephemeral, but remain extremely popular as a method to get help.

We could archive these threads in a search-indexed fashion using linen.dev or one of their competitors.

Possible Pros

Possible Cons

Open Questions

alice-i-cecile commented 2 years ago

FYI, I've been in contact with one of the founders of linen.dev (Kam Leung) over email; they've been helpful, responsive and professional so far. I've sent them the link to this issue, in case they want to dive in directly.

cheeseblubber commented 2 years ago

Kam here: How exactly does Linen handle threads?

Will they be able to support the new forum features?

answers for old Bevy versions will be archived online, which may mislead users. This is particularly bad because our rate of breaking changes is extremely high

alice-i-cecile commented 2 years ago

I'm considering a github integration so we can look up the latest commit when the message was sent so the user has some context in terms of how out of date the message is

This is a solid idea, but in our case you'd probably want to tie it to the latest release (e.g. for us on crates.io). The simplest way to do this IMO is to allow users to define a two column mini-database, with "latest release" vs "date" of the software. You could also use Github's tags system for this.

Tying to specific commits will be a bit confusing, since the commits in questions will be up to 3 months ahead of what's actually being used by users.

RhysSullivan commented 2 years ago

Hi! I was linked to this issue from IvyLashes on Discord after getting in contact with them about AnswerOverflow and asked to share a breakdown of the pros / cons of AnswerOverflow vs the competition so I'll post those below

Pros:

Cons / Missing Features

The goal for AnswerOverflow is to not only index the content of your server, but also provide tools to help improve the experience of asking questions in the setting of a chat room. If you'd like to try out any of the features of it, the server invite for it is linked in the FAQ as well

Along with that if there's any questions that I can answer or features that are requested, I'd be happy to work on those :)

alice-i-cecile commented 2 years ago

Another open source alternative (eventually): https://github.com/PostHog/squeak/issues/165

RhysSullivan commented 2 years ago

I recently finished up a couple major updates to AnswerOverflow and I figured I'd share them here as they address a few of the cons I mentioned

The biggest changes are to the UI, it's now statically generated / server side rendered so search engines will be able to index it better

Along with this, I've improved viewing searching and viewing questions

Example of viewing a question that has been marked as solved, the root message and the solution message are highlighted image

Example of viewing search results: image

On the bot side, a largely requested feature was being able to manage how AnswerOverflow views your account directly from Discord so that's added now - users in your community are now able to disable indexing of their account, no sign in required, which should help with comfort of having it image

For a channel like the help channel, AnswerOverflow should work pretty well as it'd be able to automatically thread all of the messages and let people mark them as solved when they're finished

Also the features for improving help channels work without having to index your help channels, so if you want to setup AnswerOverflow without indexing your channels yet that's also an option - that'd allow you to get mark as solution up and running as if you turn on indexing later, it'll be able to know what the solutions to the indexed questions are

Example of using mark as solution in a non indexed channel image

Example of using mark as solution in an indexed channel image

Next up on my roadmap are:

If there's anything you've noticed that'd help with asking questions in the Bevy community that you'd like to see in a bot like AnswerOverflow please also let me know, I'd be happy to add those on to it