aclist / kbin-kes

Add-on manager and scripting framework for kbin
MIT License
24 stars 8 forks source link

KES Announcement Post Drafting #59

Closed artillect closed 1 year ago

artillect commented 1 year ago

Here's my rough draft of the post announcing the release of KES. Feel free to make any edits/additions that you want, it's not completely finished but I'll keep on working on it throughout the day.

artillect commented 1 year ago

For reference, this is what it looks like right now with the markdown applied:

Introducing kbin Enhancement Suite: tailor your browsing experience with powerful customization

A couple of weeks ago, @shazbot made this post about a project that they were working on. Since then, @shazbot, @ori@sacredori.net, @minnieo and I have been hard at work, and we are excited to finally announce the official release of kbin Enhancement Suite (KES)!

With KES, we have bundled together a number of features from various userscripts, with a built-in settings menu that allows you to tailor your experience to your liking. It also offers a flexible framework that empowers script authors to effortlessly integrate scripts into KES.

What the feed looks like with everything enabled

The comments with everything turned on

The KES settings menu

Features

We’ve mostly been working on perfecting the configuration menu to make customizing your kbin experience as easy as possible. After we sort out the bug reports from this release, we plan on adding many more features! Here’s what we have so far:

  • Collapsible comments with nesting (by @artillect)
  • Use slash commands to add emoticons in text areas (by @minnieo)
  • Add syntax highlighting (with customizable themes) to code blocks (by @ori@sacredori.net)
  • Show instance names next to non-local users and communities (by @artillect)
  • Add a link to message users on your instance next to their usernames (by @shazbot)
  • Hide upvote/downvote buttons and reputation (by @artillect)
  • Show more detailed timestamps on threads and comments (by @shazbot)
  • Hide thumbnails on threads (by @shazbot)
  • Add link to subscribed magazines to the navbar (by @shazbot)
  • Replace or hide the kbin logo in the navbar (by @shazbot)
  • Add “OP” label next to thread author’s username in comments (by @shazbot)
  • Convert navigation links on profile pages into a dropdown (by @shazbot)

Each of these can be toggled in the settings menu, and some of them have additional configuration options that are also available in the settings.

Installation

Click here to install KES, and follow your userscript manager’s prompt to complete the installation.

If you don’t have a userscript management extension, you can install one of these, and then install KES using the link below:

Once KES is successfully installed, access the settings menu by clicking on the wrench icon located at the top-right corner next to your username. From there, you can enable the features you like, and customize your browsing experience.

More information

For bug reports and feature requests, visit our GitHub repository’s issues page. If you have any questions or need assistance, don’t hesitate to ask here or make a post on /m/enhancement!

Developers

If you are a userscript author, we’d love it if you could try porting your userscripts into KES, or try writing completely new ones for it! @shazbot has made it easy to integrate your scripts: you just need to add your script’s information to manifest.json, make a few small modifications to your script, add it all to the GitHub repository, and you’re good to go!

Explore KES’s documentation here to get started. If you have any questions, feel free to reach out here, on /m/enhancement, or at our GitHub repository.

aclist commented 1 year ago

Will revert back with comments in the next hour

aclist commented 1 year ago

I made a few small changes. Changed the title, not sure if I made it dumber or better. Also tried to not bury the ledge by putting the point about this being a framework first. In the prior edit, it sounded more like this was a collection of scripts we like, which wouldn't differentiate it much from other megamod packs out there. On that note, I think the first image should be the settings menu, so that it is clear this is the main focus.

artillect commented 1 year ago

Just took a look at your changes, and they look great! I'll just take one more look at it and it'll be done

aclist commented 1 year ago

I meant to say bury the lede*, oops

aclist commented 1 year ago

Final suggestion would be to make the screenshot of the modal be on a page that has more sub-settings within it? Such as radio buttons etc. I think it gives a better idea of the granular functionality

artillect commented 1 year ago

I meant to say bury the lede*, oops

Somehow my brain skipped right over that lol

Final suggestion would be to make the screenshot of the modal be on a page that has more sub-settings within it?

Sounds good, I just updated that

Shazbot commented 1 year ago

(that's not the same Shazbot, btw 😆)

aclist commented 1 year ago

Shoulda escaped the at symbol...

artillect commented 1 year ago

(that's not the same Shazbot, btw 😆)

Sorry about that! I noticed after the post was created, and figured that since you had already gotten the notification at that point there was nothing I could do lmao

aclist commented 1 year ago

Corrected a few typos

aclist commented 1 year ago

Corrected links to script (megamod.user.js -> kes.user.js) and fixed anchor links to documentation

artillect commented 1 year ago

I'm gonna head to bed, but I'll be up around 9 AM UTC-7, so I'll be able to make the post(s)/respond to comments after then

aclist commented 1 year ago

Alright, thank you, feel free to ask any other questions you may have

aclist commented 1 year ago

Added a backup of the draft here in case the above data is lost

post.md

aclist commented 1 year ago

Housekeeping: don't forget to scrub the public file from your documents