Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Add Discussions for documentation #101

Open
AristurtleDev opened this issue Feb 11, 2024 · 0 comments
Open

[Feature] Add Discussions for documentation #101

AristurtleDev opened this issue Feb 11, 2024 · 0 comments

Comments

@AristurtleDev
Copy link
Contributor

Description

Opening this as an issue to discuss adding Giscus to the documentation part of the website. This enabled a comment/feedback system on the page where readers can leave feedback on the documentation.

How it works

  • Implementing Giscus on the website is simple, it's just a small <script> snippet that gets added to the templates. This will create a new comment section at the bottom of articles/tutorials that can be enabled or disabled per document if we want.
  • Users who want to leave a comment or feedback on the document will need to click the sign-in button to authorize Giscus for their GitHub account.
  • When a comment is left for the first time, Giscus will create a new discussion thread in the repository's GitHub Discussion page. This is where the comments left are stored, so there's no additional infrastructure or backend storage setup required for the website.

Moderation

Moderation of comments left on a page is done through the GitHub Discussion thread that the document is linked to. This means anyone with access to moderate the discussions for the website repository can moderate the comments from there.

Example Implementation

I've setup an example implementation on the staging site I use for the website development. I've created two articles that both have comments enabled. You can view them at

Note
The example implementations just implement Giscus to show it working. No styling was applied to it to match the page style. If this is something we would like to implement, the discussion box would be styled to match the page.

Motivation

Allowing users to leave feedback on documentation helps us improve the documentation going forward. We could just have people open up an Issue for a specific document, but an issue isn't always the best solution. By allowing a discussion per document on the documents actual web page using Giscus, this provides a way of linking each document with a separate discussion thread in the repository so that feedback for a specific document can easily be found. If feedback left leads to something in the document needing to be changed, the discussion thread can then be linked in a new issue created in the repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant