carbon-language / carbon-lang

Carbon Language's main repository: documents, design, implementation, and related tools. (NOTE: Carbon Language is experimental; see README)
http://docs.carbon-lang.dev/
Other
32.27k stars 1.48k forks source link

Broken links #3778

Closed nathany closed 7 months ago

nathany commented 7 months ago

Description of the bug:

This is the result of running the lychee link checker against the markdown files.

lychee **/*.md --exclude-path utils/vscode/node_modules/ --github-token {personal access token with no permissions} --exclude docs\.google\.com --max-concurrency 20
[proposals/p0107.md]:
✗ [404] https://developer.apple.com/documentation/swift_packages | Failed: Network error: Not Found

[docs/design/generics/goals.md]:
✗ [ERR] https://3fx.ch/typing-is-hard.html | Failed: Network error: tcp connect error: Connection refused (os error 61)

[docs/project/cpp_style_guide.md]:
✗ [404] https://clang.llvm.org/extra/clang-tidy/checks/bugprone-argument-comment.html#bugprone-argument-comment | Failed: Network error: Not Found

[proposals/p0044.md]:
✗ [404] https://github.com/carbon-language/carbon-proposals/pull/5#discussion_r423401993 | Failed: Network error: Not Found
✗ [404] https://github.com/carbon-language/carbon-proposals/blob/d1946fab824742b4857fa74ffc1b9fe9af37375d/proposals/p0001.md | Failed: Network error: Not Found

[docs/project/faq.md]:
✗ [404] https://github.com/google/crubit/blob/main/docs/design.md | Failed: Network error: Not Found

[docs/design/generics/appendix-coherence.md]:
✗ [401] https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.86.9526&rep=rep1&type=pdf | Failed: Network error: Unauthorized
✗ [ERR] https://mail.mozilla.org/pipermail/rust-dev/2011-December/001036.html | Failed: Network error: dns error: no record found for Query { name: Name("mail.mozilla.org.local."), query_type: AAAA, query_class: IN }

[proposals/p0196.md]:
✗ [ERR] https://forums.carbon-lang.dev/t/request-for-decision-language-level-safety-strategy/196/6 | Failed: Network error: dns error: no record found for Query { name: Name("forums.carbon-lang.dev.local."), query_type: AAAA, query_class: IN }

[docs/design/README.md]:
⧖ [TIMEOUT] https://unhandledexpression.com/rust/2017/07/10/why-you-should-actually-rewrite-it-in-rust.html | Timeout

[README.md]:
✗ [404] https://drive.google.com/drive/folders/1-rsUjiya7dSZ87L8kpZmu3MZghRVxzLA | Failed: Network error: Not Found

[proposals/p0162.md]:
✗ [404] https://github.com/josh11b/carbon-lang/blob/generics-docs/docs/design/generics/terminology.md#implicit-parameter | Failed: Network error: Not Found

[proposals/p1344.md]:
✗ [404] https://github.com/carbon-language/archived-carbon-lang | Failed: Network error: Not Found

[docs/design/generics/details.md]:
✗ [404] https://github.com/apple/swift/blob/main/docs/Generics.rst#constraint-inference | Failed: Network error: Not Found

[proposals/p1367.md]:
✗ [404] https://github.com/carbon-language/carbon-lang/settings/access | Failed: Network error: Not Found

[proposals/p2173.md]:
↻ [ERR] https://3fx.ch/typing-is-hard.html | Cached: Error (cached)

[proposals/p0444.md]:
✗ [ERR] https://forums.carbon-lang.dev/ | Failed: Network error: dns error: no record found for Query { name: Name("forums.carbon-lang.dev.local."), query_type: AAAA, query_class: IN }
✗ [ERR] https://forums.carbon-lang.dev/t/contributor-directory-wiki/134/2 | Failed: Network error: dns error: no record found for Query { name: Name("forums.carbon-lang.dev.local."), query_type: AAAA, query_class: IN }

🔍 5059 Total (in 58s) ✅ 4976 OK 🚫 17 Errors 💤 64 Excluded

Link to documentation:

https://github.com/carbon-language/carbon-lang

What should it say instead?

No response

Any other information, logs, or outputs that you want to share?

This is what I was thinking:

Separately from that PR, I could run lychee against the Wiki and open a separate issue.

We could consider adding a link checker to CI if the false positives can be resolved (I could just add --accept 429, but that's not entirely ideal). Lychee has a GitHub Action, but I'm not sure if/how to integrate it with pre-commit.

jonmeow commented 7 months ago

Thanks for flagging the broken links.

I'd be cautious of validating links via GitHub action. Links to other websites may break independent of a given commit to Carbon. However, failing actions would form a barrier to commits, and creating a barrier because a commit happens to touch a file that previously had a broken link may be discouraging.