danielgtaylor / danielgtaylor/aglio

`text-overflow: ellipsis` hides the end of the URI

Open
#198 1 comment 0 reactions 0 assignees View on GitHub
bug needs plan olio theme
Dominant language
CoffeeScript
Stars
4.7k
Forks
471
PR merge metrics
No merged PRs in 30d

Description

Hi

I'm using aglio 2.2.0/olio 1.6.2.

I'm writing an API documentation involving URIs with a lot of parameters. The issue is that the URI template is cut by the css property `text-overflow: ellipsis`, which makes it difficult to read.

Here is an example using the `streak` theme with the 3-column layout :
![capture du 2015-11-20 11 51 50](https://cloud.githubusercontent.com/assets/5205295/11298107/2ccf35d0-8f7d-11e5-9cf2-48bd8a11171a.png)

It's quite a rare case, but still. (btw I'm in fullscreen mode, but people with small screen might have the issue more frequently)

You can argue that there is an example in the third column that allows to guess the end of the URI, however this can be confusing.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the theme CSS rule applying text-overflow: ellipsis to URI templates, then inspect the streak theme with the 3-column layout described in the report. The work is done when long parameterized URIs remain readable, including on small screens, without relying on the example in the third column.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.