GoogleCloudPlatform / iot-device-sdk-embedded-c

Cloud IoT Device SDK for Connectivity to IoT Core.

Other

246 stars 81 forks source link

Documentation: Fix User Guide Links to Headings #102

Closed mikevoyt closed 4 years ago

mikevoyt commented 4 years ago

Description

The links to several headings in the User Guide were broken.

Links must use all lower case, remove the colons, and substitute spaces for hyphens to get heading links working correctly.

See the code that creates links here: https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb

In summary it:

downcases the string
removes anything that is not a letter, number, space or hyphen (see the source for how Unicode is handled)
changes any space to a hyphen.
if that is not unique, add "-1", "-2", "-3",... to make it unique

How was this tested?

Viewed the User Guide on GitHub, verified the links worked as expected.

atigyi commented 4 years ago

:+1: Thank you for the fixes!