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

Link checker across nix documentation properties #841

Open
lf- opened this issue Dec 15, 2023 · 2 comments
Open

Link checker across nix documentation properties #841

lf- opened this issue Dec 15, 2023 · 2 comments
Labels
site Improvements to the site infrastructure or content presentation

Comments

@lf-
Copy link
Member

lf- commented Dec 15, 2023

Observations

If we add more links, they might break. We can automate finding broken links between our things, in principle, and run it in ci. One difficulty is that the repos aren't versioned together but this could be overcome.

Cargo's book has a link checker iirc, could maybe use that.

Problem

With more links come more possibilities to break them. We could catch the breakage automatically.

Approaches

Write script that reads html files of built sites, soups the links out, and validates the target files exist with the appropriate anchors. Run in CI here or elsewhere.

Willing to help?

Sure

Priorities

Add 👍 to issues you find important.

@lf- lf- added the site Improvements to the site infrastructure or content presentation label Dec 15, 2023
@asymmetric
Copy link
Contributor

asymmetric commented Dec 19, 2023

We do have a link checker, see here, it's run in CI as well.

EDIT: or were you talking about more than just nix.dev?

@lf-
Copy link
Member Author

lf- commented Dec 19, 2023

We do have a link checker, see here, it's run in CI as well.

EDIT: or were you talking about more than just nix.dev?

Cross ecosystem, across all our docs, yeah

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site Improvements to the site infrastructure or content presentation
Projects
None yet
Development

No branches or pull requests

2 participants