github.com/shurcooL/issuesapp/...

Marking issue posts off-topic #41

Closedelmindreda opened this issue 2 years ago
elmindreda commented 2 years ago

Writing this in response to this request.

It would be handy to be able to mark individual posts in an issue thread as off-topic. It's not uncommon that people with a similar but unrelated issue drop by, describe their problem and ask if it's the same bug. This is really a Good Thing and should be encouraged, but it can add a lot of noise to an already long and un-threaded discussion. It also raises the bar for the next person looking to avoid creating a duplicate, especially since the feedback on each off-topic "sub-thread" comes at the end.

Deletion seems too harsh and also removes valuable information, i.e. that this is not that other similar issue. Manual editing is possible, although GitHub Markdown doesn't offer any particularly compelling alternative. Strike-through makes it hard to read and quoting is a pain to apply manually. Having a Mark as off-topic widget at the top of each post, that tags it and greys it out, seemed like a good compromise.

Write Preview Markdown
dmitshur commented 2 years ago · edited

Thanks a lot for making the suggestion, I will consider it.

An initial question about this:

Manual editing is possible, although GitHub Markdown doesn't offer any particularly compelling alternative.

Are you already familiar with, and have you considered the <details> HTML tag that GFM supports?

For example:

Imagine a long and detailed section here.

It's collapsed by default, but can be expanded if you want more details.

You could edit other people's off-topic posts, wrapping them in this section. Perhaps even include <summary>Off-Topic</summary>.

You can also see an example of me hiding some detailed information this way, while still making it available to those interested, at:

Final thought. It's worth considering a button/shortcut that makes use of this <details> HTML tag.

Write Preview Markdown
dmitshur commented 2 years ago · edited

It's not uncommon that people with a similar but unrelated issue drop by, describe their problem and ask if it's the same bug. This is really a Good Thing and should be encouraged, but it can add a lot of noise to an already long and un-threaded discussion. It also raises the bar for the next person looking to avoid creating a duplicate, especially since the feedback on each off-topic "sub-thread" comes at the end.

Also, if you don't mind, it'd be very helpful to see some occurrences of this issue in the real world. Could you link to some threads where you've seen it happen? That would help me understand the problem more and evaluate any potential solutions.

Write Preview Markdown
elmindreda commented 2 years ago

Are you already familiar with, and have you considered the <details> HTML tag that GFM supports?

I wasn't. That's lovely! <summary> seems to work as well. Yes, that'll do.

Write Preview Markdown
dmitshur commented 2 years ago · edited

I see. Great to hear, because if <details> tag is sufficient, that means there's a simple existing solution and no new features need to be added! Best part, you can use it on github.com too! :)

Still, if you don't mind, I'd find it helpful to see a few real-world examples of issues where you wanted this feature (as described in original post).

Write Preview Markdown
elmindreda commented 2 years ago

Still, if you don't mind, I'd find it helpful to see a few real-world examples of issues where you wanted this feature (as described in original post).

I went back and looked and couldn't even find the issue that prompted the tweet. I did find some instances of resurrection, where someone shows up in a resolved issue with a different one, but that's not what I described above.

So at minimum it's really rare and possibly I imagined the whole thing and suggested an unnecessary solution to a non-existent problem, neither of which is ideal. 🦉

Thank you for the clue.

Write Preview Markdown
elmindreda closed this 2 years ago
dmitshur commented 2 years ago

No problem. I'm glad we arrived at a constructive solution. Thanks for contributing! :)

Write Preview Markdown
to comment.