Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use explicit links for documentation cross-references #723

Open
trey-stafford opened this issue Aug 14, 2023 · 0 comments
Open

Use explicit links for documentation cross-references #723

trey-stafford opened this issue Aug 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@trey-stafford
Copy link
Contributor

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.

@trey-stafford trey-stafford converted this from a draft issue Aug 14, 2023
@trey-stafford trey-stafford added the documentation Improvements or additions to documentation label Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

1 participant