senzing-factory / build-resources

Collection of utilities to aid with build process
Apache License 2.0
1 stars 1 forks source link

Favor Reference Style Links in our Markdown files #110

Open kernelsam opened 7 months ago

kernelsam commented 7 months ago

Problem

See: https://www.markdownguide.org/basic-syntax/#reference-style-links

Currently most of our markdown is using inline links and repeating the same link multiple times which has caused a lot of extra work during migration. This can be mitigated by using reference links. See implementation here:

Do note from the above example that when viewing the github preview of the markdown, the reference links will not be displayed at the bottom of the file: https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/create-senzing-github-repository.md

Standards: