search

stdlib-js / www

Website for stdlib, a standard library for JavaScript and Node.js.
https://stdlib.io
Apache License 2.0
6 stars 8 forks source link

[RFC]: add chat to the API documentation to facilitate user engagement #33

Closed kgryte closed 2 years ago

kgryte commented 2 years ago

Description

This RFC proposes adding chat functionality to the API documentation to facilitate user engagement.

When a user has a question, particularly when navigating the project given its size, would be great to provide a mechanism by which a user can ask a question without needing to, e.g., navigate to GitHub and open an issue, but instead, ask in a (public) chat forum.

One potential solution is using Gitter sidecar. We already use Gitter for community chat. This would simply embed the chat in the website, without a user needing to navigate to a separate website.

Related Issues

No.

Questions

No.

Other

No.

Checklist

kgryte commented 2 years ago

Given that we will want to embed the chat in a React app, will probably want to use custom buttons for toggling the chat. See the Gitter example.

Planeshifter commented 2 years ago

This has been added using sidecar with a custom toggle button.

kgryte commented 2 years ago

We probably don't want to show, or even allow, Gitter on mobile. Just not likely that someone is going to want to pull up Gitter chat while browsing around on their phone. In which case, keeping the bottom Gitter navigational element around for that use case makes sense to me, as we can potentially deep link it to open the Gitter app, if it is installed on a user's mobile device.

Planeshifter commented 2 years ago

Hmm, I didn't like to have two Gitter links in the footer because it forces one to navigate more elements when using the keyboard and is redundant (the sidecar button is a link that will also work when JS is disabled / can be right-clicked like any other <a /> tag). We could use @media and depending on screen size either show the Gitter button or just a link in the bottom nav bar.

kgryte commented 2 years ago

Correct. I was not necessarily advocating for two links. But we could toggle the display based on the viewport.

Planeshifter commented 2 years ago

Yes, that would make sense to me! Same for the "Help" button too which may be in the way on mobile devices.

Planeshifter commented 2 years ago

Changed accordingly per https://github.com/stdlib-js/www/commit/ebdba3f0ea3b84e17955a7ee061343323da98611.

kgryte commented 2 years ago

Gitter chat has now been added and has been deployed. Closing...