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

Check for broken links in the documentation #44

Open
GenevieveBuckley opened this issue Nov 24, 2021 · 6 comments
Open

Check for broken links in the documentation #44

GenevieveBuckley opened this issue Nov 24, 2021 · 6 comments

Comments

@GenevieveBuckley
Copy link

I've noticed some broken links in the napari-plugin-engine documentation pages. We should fix these, possibly with the same link checking we do for hte napari.github.io respository: https://github.com/napari/napari.github.io/blob/main/.github/workflows/link-checker.yml

One example of a broken link: on this page the linked named "See also: documentation for writing a napari plugin" produces this 404 error.

@tlambert03
Copy link
Contributor

Recently Tried to fix that specific link in #42 ... need to figure out why it didn't work.

Did you find any others?

@GenevieveBuckley
Copy link
Author

I didn't look for any others, figured it might be quicker to let an automated link checker do that 😄

@tlambert03
Copy link
Contributor

I ask because that might literally be the only page with links in these docs. (Not a lot of links).

But feel free to make a PR with the link checker if you want!

@GenevieveBuckley
Copy link
Author

Ah, well then maybe that's overkill. Not super familiar with how extensive these docs are, or how many links.

I'm slightly concerned that if we fix that individual link, and then the reorg shuffles files around, it might just break again (probably what happened here in the first place). So it might make sense to wait a little bit, or schedule a follow up/

@tlambert03
Copy link
Contributor

the reorg no longer uses this repo at all! so no worries there

@GenevieveBuckley
Copy link
Author

It is super weird, I don't know why #42 didn't fix things.

I am looking at latest, and it's not a caching issue (I see the same thing happen in a private window).

Was the main branch renamed from master recently? Which branch does github think it's building the docs with?

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

No branches or pull requests

2 participants