readthedocs / readthedocs/ext-theme

Popup cards: API driven usage support

Open
#196 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Improvement Needed: design decision
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

There are a few places where these popup cards or similar elements are used but the data inside the popup cards is purely API driven. In most places, these cards are data driven from the templates, though usually have some data patched in from an API response.

To make popup cards optionally API driven:

  • The popup card template should be output inline as a template. This only needs to happen once on the page, as the JS can reference the template to embed the rendered template.
  • The popup card template shouldn't need to hit the API again, as we are likely working from an existing API response.
  • The existing popup card pattern should still remain, and the API driven interface is probably some more like a template parameter, ie {% include 'includes/elements/chip/project.html' template=True %}

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

Locate the popup card templates and the JavaScript path that renders popup content. Check how a template can be emitted once, reused with an existing API response without another request, and still support the current include pattern. Done means both template-driven and optionally API-driven popup cards work without duplicate API calls.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.