nsidc / qgreenland

Source code for generating the QGreenland package hosted at https://qgreenland.org/
https://qgreenland.readthedocs.io
Other
36 stars 9 forks source link

Use explicit links for documentation cross-references #723

Open trey-stafford opened 11 months ago

trey-stafford commented 11 months ago

Our documentation has a fair number of cross-references that link to other parts of the documentation. In these cases, we have generally used the /path/to/md_file.md#specific-reference-by-header-title style of referencing. E.g.,

[How to contribute styles](/contributor/how-to/contribute-styles.md)

Explicit references provide more flexibility and are not tied to specific files/header sections. This would allow us to refactor docs more easily.