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

Update index.md #3646

Merged
merged 1 commit into from
Jan 3, 2022
Merged

Update index.md #3646

merged 1 commit into from
Jan 3, 2022

Conversation

JeremyLikness
Copy link
Member

Update links to correct paths. Fixes #3639.

Update links to correct paths. Fixes #3639.
@JeremyLikness JeremyLikness requested a review from a team December 29, 2021 16:54
Copy link
Member

@roji roji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks OK but I think we prefer xref for internal links such as these (/cc @smitpatel)

@JeremyLikness
Copy link
Member Author

Thanks @roji. Am interested in what @smitpatel says because this documentation suggests XREF is for API documentation.

@smitpatel
Copy link
Contributor

xref references pages using their ids. That helps with API mainly so it can reference links from other docset. For pages in same docset - using relative file.md, using relative link path and using xref all works the same. We as a team went to use xref because that causes least number of break whenever we rename something as long as the unique id given to page doesn't change. One of those case where we defer from official docs for ease of maintenance. I frown upon using relative file path as we don't get warning about them being broken in build.

@roji
Copy link
Member

roji commented Jan 3, 2022

I frown upon using relative file path as we don't get warning about them being broken in build.

Yeah, that part seems pretty important.

@JeremyLikness
Copy link
Member Author

I will squash/merge and look at migrating to xref on future revisions.

@JeremyLikness JeremyLikness merged commit c671248 into main Jan 3, 2022
@smitpatel smitpatel deleted the JeremyLikness-fixes-links-at-port branch January 4, 2022 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Behaivor changes link is broken
3 participants