BenShelton / BenShelton/library-api

[Feature] Show Paragraph Number on Image

Open
#65 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
TypeScript
Stars
13
Forks
3
PR merge metrics
No merged PRs in 30d

Description

**Packages**

Media

**Describe the solution you'd like**

When an image is meant to be shown with a paragraph, the text "(See paragraph x)" is normally at the end of the image description. This means you have to scroll down on each description to see what paragraphs they relate to.

It would be easier if we could in some way extract that number and display it on the image itself (similar to how the Download icon overlays videos that are not downloaded)

**Describe alternatives you've considered**

Scrolling down the description to view the paragraph number

**Additional context**

Although images would never show the Download icon I don't think it would look good on the top right. Perhaps the bottom left which would match how the song number is displayed on song video thumbnails.

Also we need a way to do this across languages so a regex will probably be difficult to get working on all languages. If there is any extra metadata we can take about the image itself from the publication db that indicates what paragraph it relates to that would be a better option.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Media package and tracing the image data returned by the API, then inspect whether publication database metadata exposes the related paragraph. The work is complete when a reliable cross-language approach is defined and the related paragraph number is shown on image displays without requiring users to scroll through descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.