Skip to content

Serial-Studio/Comments

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

Comments

Comment threads for serial-studio.com.

This repo contains no code. It exists only as a backing store for giscus, which uses GitHub Discussions as a free, ad-free, tracker-free comment system.

How it works

The website pages at serial-studio.com/examples, serial-studio.com/help, and serial-studio.com/extensions are dynamic: each example, help topic, or extension is rendered into the same URL but identified by a hash fragment. To give every item its own isolated comment thread, the website embeds a giscus widget configured with data-mapping="specific" and a per-item term in the form:

<section>:<item-id>

For example:

  • examples:mqtt-basic
  • help:getting-started
  • extensions:my-theme

The first time someone comments on a given item, giscus opens a new Discussion in this repo's General category using that term as the title. Every subsequent visitor lands in the same Discussion. Replies in either place — on the website or directly on GitHub — stay in sync.

Why a separate repo?

Keeping comments out of the main Serial-Studio/Serial-Studio repo means:

  • The main repo's Discussions tab stays focused on questions, ideas, and announcements about the application itself.
  • Auto-created comment threads (one per documented item) don't clutter the project's notification feed.
  • Moderation can happen here without touching the main project's permission model.

Moderation

Anyone with write access to this repo can lock, delete, or hide comments and reactions through the standard GitHub Discussions UI. Hiding a comment on GitHub also removes it from the website embed.

To report an abusive comment, use GitHub's report flow on the comment itself, or email alex@serial-studio.com.

Posting comments

Visit any page on serial-studio.com that has a "Comments" section, sign in with GitHub, and post. You can also reply directly from the GitHub Discussion view if you prefer.

Related

License

The Discussions hosted here are user-generated content owned by their respective authors. The repository configuration itself is released under the same terms as the Serial Studio website (GPL-3.0).

About

Comment threads for serial-studio.com, backed by giscus and GitHub Discussions.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors