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.

Sign up for GitHub

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

Jump to bottom

Markdown validation not validating markdown link fragments #2141

Closed
petertonysmith94 opened this issue Apr 23, 2024 · 3 comments · Fixed by #2218
Closed

Markdown validation not validating markdown link fragments #2141

petertonysmith94 opened this issue Apr 23, 2024 · 3 comments · Fixed by #2218
Assignees
@petertonysmith94
Labels
docs

Comments

@petertonysmith94
Copy link
Contributor

We have links to sections on a page #typegen (see example). There is currently no validation to check that they exist and therefore, are broken.|

We should add validation to ensure that, all our links work as expects, so the user can navigate the documentation with ease.
@maschad
Copy link
Member

maschad commented Apr 29, 2024

Might be worth adding a CI job with a markdown link checker such as https://github.com/tcort/markdown-link-check

@arboleya
Copy link
Member

Like this one? .github/workflows/md-lint.yaml

cc @Dhaiwat10

@petertonysmith94
Copy link
Contributor Author

Looks to me the rule no-dead-link is not being applied.

@petertonysmith94 petertonysmith94 self-assigned this Apr 30, 2024
@petertonysmith94 petertonysmith94 changed the title Markdown validation not validating markdown hashtags Markdown validation not validating markdown link fragments May 1, 2024
@petertonysmith94 petertonysmith94 mentioned this issue May 1, 2024
Merged
@petertonysmith94 petertonysmith94 mentioned this issue May 13, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@petertonysmith94 petertonysmith94

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: add relative link lint for lint:md-links FuelLabs/fuels-ts
3 participants
@arboleya @maschad @petertonysmith94