MycroftAI / documentation

Mycroft.AI documentation for all public facing technical components.
https://mycroft.ai/documentation
Apache License 2.0
80 stars 90 forks source link

Introduction-developing-skills broken internal link #60

Closed jrwarwick closed 6 years ago

jrwarwick commented 6 years ago

The link labled "Simplifying your Skill code with intent_handler decorators" at the top of the Developing a new skill page contains a URL anchor that is incorrect. Destination href: https://mycroft.ai/documentation/skills/introduction-developing-skills/#simplifying-your-skill-code-with-intent_handler-_decorators_

is invalid. probably those underscores are formatting that leaked into href. There does exist this anchor: "#simplifying-your-skill-code-with-intent_handler-decorators" which is surely what should have been in the href attribute.

jrwarwick commented 6 years ago

Actually it looks like there may be several internal anchor links broken in a variety of ways. Here is a second case: view-source:https://mycroft.ai/documentation/skills/skill-settings/#settingsjson but the real anchor is #settings-json (with an hyphen in the middle).

KathyReid commented 6 years ago

Thanks for reporting these @jrwarwick. I use a toc-markdown program to generate the Tables of Contents on each Documentation page; https://github.com/jonschlinkert/markdown-toc

You're right though, there should be some sort of validation step in our process.

KathyReid commented 6 years ago

Way behind on triaging / closing some of these, apologies. Internal links updated. https://validator.w3.org/checklink?uri=https%3A%2F%2Fmycroft.ai%2Fdocumentation%2Fskills%2Fintroduction-developing-skills%2F&hide_type=all&depth=&check=Check

Closing issue.