OctoPrint / OctoPrint/plugins.octoprint.org

[Feature Request] Reduce stale plugin descriptions

Open
#380 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Less
Stars
144
Forks
370
Avg merge
4d 3h
Merged PRs (30d)
3

Description

I've just gone through the plugin repository to pick the plugins I'd like, and I almost missed one due to a stale description.

To install OctoPrint-SlicerSettingsTab, I need OctoPrint-SlicerSettingsParser. The description says it's only compatible with two slicers. I use Cura, not listed, so I almost didn't install this. I checked GitHub, just in case, and the description states that it now does support Cura, though an additional step is required. It's reasonable to assume a lot of Cura users would have passed this plugin by due to this stale description.

When a plugin is on GitHub, it would be useful to generate the description by copying it from GitHub during a periodic (daily?) refresh/check for updates (appreciate that not all are on GitHub, though all the ones I've looked at have been) to automatically keep the OctoPrint Plugins data up to date.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or existing refresh entry point. Start by tracing how plugin descriptions are sourced and updated, then examine the proposed periodic GitHub refresh and its handling of plugins that are not hosted on GitHub. Done means stale descriptions are updated without breaking unsupported sources.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
content, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.