Skip to content

Add Giscus comments system - #267

Draft
fflaten wants to merge 5 commits into
pester:mainfrom
fflaten:giscus
Draft

Add Giscus comments system#267
fflaten wants to merge 5 commits into
pester:mainfrom
fflaten:giscus

Conversation

@fflaten

@fflaten fflaten commented May 3, 2023

Copy link
Copy Markdown
Collaborator

Implements Giscus as comment system for all Docs and Commands-pages. Only index-page is currently excluded.
Comments are stored and managed as discussions in specific category in the docs-repo.

Fix #251

TODO:

  • Install Giscus app in docs-repo
  • Enable discussion in docs-repo. Remove default categories and create a "Comments" or "Website Comments"-category of Announcement-type
  • Update config
  • Reswizzle after Docusaurus v3 upgrade Docusaurus v3 #272

@bravo-kernel

Copy link
Copy Markdown
Collaborator

Looks amazing. Perhaps comments could also be excluded for the Additional Resources section but to be honest, I think that whole section should either be dropped or totally reworked anyway. It's just a lot of very (years old) content for which a google search provides better results.

@fflaten

fflaten commented May 4, 2023

Copy link
Copy Markdown
Collaborator Author

Great minds. See #264 😁
Until then, comments to help crowdsource what works or not is an improvement.

@fflaten fflaten changed the title Add Giscus comments to docs pages Add Giscus comments system May 5, 2023
@fflaten

fflaten commented May 5, 2023

Copy link
Copy Markdown
Collaborator Author

A few sample pages:

What do you think @nohwnd?

@bravo-kernel

Copy link
Copy Markdown
Collaborator

LGTM shall we just merge this?

@fflaten

fflaten commented May 16, 2023

Copy link
Copy Markdown
Collaborator Author

Can't, see task list in PR details. Using my fork's discussion atm. So waiting on approval and actions from @nohwnd 🙂

@bravo-kernel

Copy link
Copy Markdown
Collaborator

Ahhh 🤦🏻

@fflaten

fflaten commented Jun 15, 2024

Copy link
Copy Markdown
Collaborator Author

How should we handle docs version changes? E.g. when we move /docs/* from v5 to v6 in the future, the existing comments made in v5-lifetime will show up on v6-pages which might be rewritten.

Options:

  1. Is that okay? Comments can become out of date during minor upgrades and docs-upates either way.

2) Should we move to always use versioned URLs in #316 and rather redirect /docs/* to latest stable (/docs/v5/*)? That way canonical URIs used to link page -> discussion-issue always /v5, /v6 etc. Be aware, this would also show versioned URIs in Google search results

  1. Is it possible to get the version inside a Docusaurus component (Giscus.js) so we can build versioned backlink-URI?


return (
<Head>
<meta name="giscus:backlink" content={canonicalUrl} />

@fflaten fflaten Jun 15, 2024

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always add version here? Maybe possible to get current page version dynamically through useDocusaurusContext() to avoid hardcoding replace /docs/ with /docs/v5 for stable like we do in _redirects ?

E.g. when we move to v6 as latest, comments follow the v5 versioned docs and v6 starts fresh as it's hopefully had a rewrite or page might be removed.

@fflaten fflaten mentioned this pull request Jun 17, 2024
16 tasks
@nohwnd

nohwnd commented Aug 11, 2026

Copy link
Copy Markdown
Member

@fflaten is this still something we want?

What is left here is all admin, enable Discussions on pester/docs, make a category, install the app. But we have Discussions on pester/Pester now with 104 threads, so turning them on here too gives people two places to talk, and the ones here would be the quiet ones.

The part Discussions does not give us is per-page comments, so it is a real question, not a hint to close :) If you still want it I can do the setup, otherwise let's close and reopen if it comes up again.

🤖

@fflaten

fflaten commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator Author

This idea and pester/pester discussions serve different purpose. Pester-repo generally redirects users with doc related questions.

The comment system would allow easy feedback by the reader, without the cost of having to figure out where to report it.

Still - fine with closing until more demand. Would probably end up being mostly support issues.

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

Successfully merging this pull request may close these issues.

Giscus comments

3 participants