Fix broken links and update link checking docs #2327
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is done in support of #2319
|
This is the branch protection rule I want to enable: The key callouts are:
I will enable this once it gets approval |
|
@eshon and @lanzafame : I think this is ready for review. Please look at #2327 (comment) as well. |
This was referenced Oct 7, 2024
lanzafame
requested changes
Oct 9, 2024
README.md
Outdated
| @@ -30,6 +31,10 @@ This repository manages the documentation for the [Filecoin network](https://fil | |||
|
|
|||
| Want to help out? Pull requests (PRs) are always welcome! If you want to help out but aren't sure where to start, check out the [issues board](https://github.com/filecoin-project/filecoin-docs/issues). | |||
|
|
|||
| ### Link checking | |||
|
|
|||
| Links are checked using [lychee-action](https://github.com/lycheeverse/lychee-action) as confirugred by [check-external-links.yml](.github/workflows/check-external-links.yml). Working links are required before merging. If you have a link that should be excluded from checking use [`.lycheeignore`](https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#excluding-links-from-getting-checked) | |||
There was a problem hiding this comment.
I would add that raw links need backticks and not <code> blocks around them to work with the link checker.
There was a problem hiding this comment.
@lanzafame : i think <code> block works too. I have updated the README.
lanzafame
approved these changes
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is done in support of #2319