readthedocs / readthedocs/ext-theme

Add reusable badge for plan level label

Open
#281 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Accepted Feature Improvement
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

In #227 we discussed whether the "Pro plan" label/badge should stick around after a user upgraded. There is some value in keeping the plan name here as it is probably a reminder of the features that come with the plan. However, I usually see services discarding upgrade buttons and labels on features like this after you upgrade. There is also value here as we shouldn't confuse the user by implying they don't have the Pro plan.

We have a need for this in a few areas, it would be nice to have a solution that:

  • Takes into account the current plan level and becomes visually distinct when the plan level is already met/exceeded. Most likely we'll want to play around with some visual styles like adding a check mark and making the text muted colors.
  • This should be reusable -- either on the template side as an include or on the JS side as a web component maybe. All the information is available to the templates however.
  • The label should trigger a popupcard with more detailed information on the plan and current plan level. This would be a template implementation mostly.

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

Start by reading issue #227 and the linked discussion in pull request #277, then locate the existing plan labels and popupcard templates in ext-theme. The reusable label should reflect the current plan level, look distinct when the level is met or exceeded, and open a popupcard with plan details.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.