question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs css: not always obvious that code elements are links

See original GitHub issue

I’m submitting a…


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[ X] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
[X ] Other... Please describe: AIO docs-infra CSS

Current behavior

Currently, if something in code font is also a hyperlink, there is no visual indication until you hover over the text. Then, an underline appears and the cursor shape changes to indicate that it is a hyperlink.

This is true is all dgeni-generated docs, including both API ref and CLI command ref.

Expected behavior

Some readers have reported that they didn’t know these code elements are links.

The most recent report is about the table of schematics in ng generate. It wasn’t obvious that the items in this list link to more detail below. Minimally, if we can fix that case (code in a list, or code in a table?) that might help. Perhaps make the underline persistent, even without the hover?

It might be too much clutter to highlight hyperlinked code in larger syntax statements and code examples in the API ref. Know, however, that without a visual indicator it’s a learned behavior and extra step to try hovering to see if there is more info.

Minimal reproduction of the problem with instructions

code-font-hyperlink-default-cli-list code-font-hyperlink-hover-cli-list code-font-hyperlink-default-httpclientmodule code-font-link-hover-httpclientmodule

What is the motivation / use case for changing the behavior?

Help users more easily know when additional information is available with a single click.

Environment


Angular version: X.Y.Z


Browser:
- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
- [ ] Firefox version XX
- [ ] Safari (desktop) version XX
- [ ] Safari (iOS) version XX
- [ ] IE version XX
- [ ] Edge version XX
 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:10 (9 by maintainers)

github_iconTop GitHub Comments

2reactions
petebacondarwincommented, Apr 19, 2020

We have a dgeni processor that tries to “auto-link” code items. This goes through all the generated code snippets in the rendered HTML and tries to infer if a word in a snippet matches an API item. If so then it creates a link to it. This is quite good but does occasionally get it wrong - either missing an word that could have been linked or linking a word incorrectly. @sonukapoor has recently improved the algorithm for this so it is better than ever. But I am still nervous about highlighting them. I worry that we will then be inundated with issues of incorrect links… The auto-links are really just a bonus rather than a required link - perhaps you could think of them as Easter eggs? 😸🥚

0reactions
angular-automatic-lock-bot[bot]commented, Nov 9, 2020

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

Read more comments on GitHub >

github_iconTop Results From Across the Web

link - CSS: Cascading Style Sheets - MDN Web Docs
The :link CSS pseudo-class represents an element that has not yet been visited. It matches every unvisited or element that has an href ......
Read more >
A Complete Guide to Links and Buttons - CSS-Tricks
Our complete guide to links, buttons, and button-like inputs in HTML, CSS, and JavaScript.
Read more >
CSS not being applied in pages :/ · Discussion #22495 - GitHub
Now, i'm trying to move my codepen HTML and CSS over here. HTML is working, but CSS is not being applied. I'm obviously...
Read more >
Links in HTML documents - W3C
Links and anchors defined by the A element must not be nested; an A element must not contain any other A elements. Since...
Read more >
Links - Usability & Web Accessibility - Yale University
In that case, a screen reader may only read the link text and not the ... Either select one element to be the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found