sindresorhus/refined-github

Meta-feature: Add information box to each `feature` file #3630

fregante posted onGitHub

On this same repo, when visiting a feature file (https://github.com/sindresorhus/refined-github/blob/master/source/features/action-used-by-link.tsx) we could display a box with parsed information about the feature, both as documentation and as a debug helper.

<img width="1043" alt="" src="https://user-images.githubusercontent.com/1402241/95401399-b6ebe780-08d2-11eb-90ba-1649af885c5c.png">

Content the box could include:


Can't we get the description/screenshot from the options page? That would avoid parsing the Readme.

posted by yakov116 over 4 years ago

We could, we’d just need to use the __featuresMeta magic variable to have them instantly available.

posted by fregante over 4 years ago

I would like to discuss the following points.

  • links to PRs that implemented it, like the history page without clutter (skips any meta PRs) — discussed here first

I don't see any benefit over using history, plus using history follows renames. Another issue is that some features went through so many renames/dir changes that there is no way to even find its implementation.

What problem are we solving with this?

posted by yakov116 over 4 years ago

The benefit is that it could skip clutter like meta and lint commits, specifically linking to the meaningful PRs. As for the renames… yes, that’d be a problem. Are we really sure that still there isn’t a way to list commits following renames via the API?

Second part: it’s useful to know where it’s been discussed and the text would show us whether it currently has issues. But I guess a simple link could also be useful.

posted by fregante over 4 years ago

See https://github.com/sindresorhus/refined-github/pull/3693 for the code to get the featues and api call for history.

posted by yakov116 over 4 years ago

Fund this Issue

$0.00
Funded

Pull requests