Skip to content

Commit e6b5b29

Browse files
committed
Add link checking to CONTRIBUTING.md and remove package-lock.json
1 parent 9bd1543 commit e6b5b29

File tree

2 files changed

+16
-17186
lines changed

2 files changed

+16
-17186
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ There are many ways to get involved. Follow this guide and feel free to [reach o
1010

1111
- [Development guide](#development-guide)
1212
- [Running the site locally](#running-the-site-locally)
13+
- [Checking for broken links](#checking-for-broken-links)
1314
- [Branching](#branching)
1415
- [Project structure](#project-structure)
1516
- [Publishing the updated site](#publishing-the-updated-site)
@@ -53,6 +54,21 @@ Finally, open http://localhost:3000 to view it in the browser.
5354

5455
The GraphQL website is built with [Nextra](https://nextra.site). This means that a hot-reloading development environment will be accessible by default.
5556

57+
### Checking for broken links
58+
59+
We use [Lychee](https://github.com/lycheeverse/lychee), a Rust-based CLI tool, to check for broken links in our documentation.
60+
61+
To install Lychee locally:
62+
63+
1. Install Rust: https://www.rust-lang.org/tools/install
64+
2. After installing Rust, run:
65+
66+
```bash
67+
cargo install lychee
68+
```
69+
70+
With Rust and Lychee installed, run the link checker: `pnpm run check:links`.
71+
5672
### Branching
5773

5874
Active development for graphql.org happens on the `source` branch. Be sure to create any new branches or direct any pull requests back to `source`.

0 commit comments

Comments
 (0)