V3: Adding links.json

[iHiD]

We are adding a links.json file to all concepts. The purpose of this file is provide helpful links that provide more reading or information about a concept. These might be official docs, a great tutorial, the PR that added it to the language, etc.

They will be rendered something like this:

These links do not replace the more contextual links within an about.md, but provide a quick set of overarching reference points for a student.

---

Each link needs:

• A url
• A description, as the link text.

You will notice in the screenshot we show an icon next to the link. We will use the site's favicon for this, but you may override it by providing an optional icon_url.

[iHiD]

Question: Could we add an optional author link to link to their website or whatever if they want

No, credit to the authors of the exercise works through. a different mechanism.

[SaschaMann]

I think we're talking about different authors. The authors of those posts are probably not on Exercism?

[iHiD]

I think we're talking about different authors. The authors of those posts are probably not on Exercism?

Then no, I don't think we should credit those authors. The authors should be credited on the sites we link to (e.g. if we link to MS docs or Wikipedia pages, those sites should credit their own authors)

[angelikatyborska]

Will backticks in the link's description be interpreted as "please write this in a monospace font"?

[iHiD]

Yes. But you may have to remind me of this when I forget and it doesn't work 😀

[SaschaMann]

Will additional fields be accepted but ignored? I'd like to add a comment of why I think the link belongs to a concept for other maintainers since it's not obvious without following and reading it. Unfortunately, JSON doesn't support this so I'd have to add a field.

[iHiD]

Yep. That's fine. Maybe start the key with __ to imply that it shoudn't ever be read by the system.