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

Fix documentation links. #2338

Merged
merged 2 commits into from
Jan 26, 2023
Merged

Fix documentation links. #2338

merged 2 commits into from
Jan 26, 2023

Conversation

xStrom
Copy link
Member

@xStrom xStrom commented Jan 17, 2023

I went over all the documentation and fixed every broken link I could find. It's not perfect, there are still broken links that are caused by code that is not in this repo (kurbo, piet, im) but obviously those will need to be fixed elsewhere.

The strategy here was to resolve broken links by changing the URL link to a rustdoc managed symbol based link. This method supports the link appearing at different levels of nesting (which URL links never did) and also has the benefit of sometimes being automatically detected when broken. Not every link was converted, but the remaining URL links still work.

Another thing to note is that when a symbol is in scope then the link doesn't have to be defined at all.

/// If the [`Widget`] trait is in scope, then that link will just work.

@xStrom xStrom added docs concerns documentation S-needs-review waits for review labels Jan 17, 2023
Copy link
Contributor

@jaredoconnell jaredoconnell left a comment

Choose a reason for hiding this comment

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

Fixes and improvements to documentation are appreciated!
I tested this locally and it looks good in the files I tested.

@xStrom xStrom added this to the Release 0.8 milestone Jan 23, 2023
Copy link
Contributor

@longmathemagician longmathemagician left a comment

Choose a reason for hiding this comment

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

This is a huge improvement even though a few more fixes are needed elsewhere.

@longmathemagician longmathemagician removed the S-needs-review waits for review label Jan 26, 2023
@xStrom xStrom merged commit ac192be into linebender:master Jan 26, 2023
@xStrom xStrom deleted the doc-links branch January 26, 2023 23:50
xStrom added a commit to xStrom/druid that referenced this pull request Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs concerns documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants