Bot-docs: Sample links easy to overlook

Created on 29 Jan 2019  Â·  4Comments  Â·  Source: MicrosoftDocs/bot-docs

I spent some time on this page learning where to paste the provided sample code. After search a long time I found that in the prerequisites "C#" and "JS" are links. Maybe you can make it more clear that those are links to GitHub; so the next reader finds it faster.


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Most helpful comment

@ivorb the text doesn't look bigger in the doc today but regardless bigger text isn't necessarily the issue here. We should have more descriptive (and accessibility-friendly) link text like "C# Sample on GitHub" vs just "C#", etc. This is true throughout our docs.

All 4 comments

made the links a little larger pieces of text, so they should be more visible

@ivorb the text doesn't look bigger in the doc today but regardless bigger text isn't necessarily the issue here. We should have more descriptive (and accessibility-friendly) link text like "C# Sample on GitHub" vs just "C#", etc. This is true throughout our docs.

To add to what @brandonh-msft said, having a link which simply reads C# is equivalent to having link text which is simply "here". It doesn't tell the reader, and more importantly a screen reader, what is on the other side of the link. We need to have more descriptive text, rather than simply larger text.

The text now says "C# sample", which is more noticeable and descriptive. Closing this, as this sample isn't the only one that has the super short (C#) link. We'll be fixing the rest of them in bulk to be a bit longer/more descriptive

Was this page helpful?
0 / 5 - 0 ratings