Acknowledged
CIQQA-3058

Feature request: in API docs, add link to relevant Core Topic, when applicable

e.g. If I am looking at https://developer.garmin.com/connect-iq/api-docs/Toybox/Complications.html, it might be helpful to have a handy link to https://developer.garmin.com/connect-iq/core-topics/complications/

For many API modules, the related core topic doc has invaluable background and context.

  • One problem is that these links don't stick around forever.

    There might actually even be 1 or 2 links in the API docs to outside sources (like the other CIQ docs), but they don't work anymore because the URLs have changed.

    There's definitely "blog posts" in the Connect IQ docs which have broken links pointing to old forum topics whose URLs have changed and vice versa. (*All* links to the forums were broken when the forum platform changed years ago, and several CIQ doc urls have changed over the years too.) That's right: some of Garmin's links to their own sites don't work.

    So I imagine there may be some reluctance to add links which may not work in the future.

    (Captain Obvious says that one way around this would be to make sure that old doc links continue to work forever, even if it means redirecting old URLs to new URLs....) 

  • Wow! Yes, these things are called hyperlinks and they are hyper useful. Half of the forum is links or citations from those pages. It's sometimes hard to find something in search engines even when I remember I saw something there (or somewhere else) Would be great if Garmin could slowly but steadily add as many of these links as possible.

    Other ideas (but this is just of the top of my head):

    From where colors, fonts, layouts, screen size are mentioned (i.e setColor) to the url with the list of all the devices with their palette, fonts, DataField layouts, screen dimensions, etc

    Properties - settings & properties page