Skip to content

Commit 83c92e3

Browse files
kixelatedclaude
andauthored
Fix lychee CI link checker failures (#1269)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 9198f4d commit 83c92e3

File tree

11 files changed

+36
-20
lines changed

11 files changed

+36
-20
lines changed

.github/workflows/check.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ jobs:
1313
runs-on: ubuntu-latest
1414

1515
steps:
16+
- name: Free disk space
17+
uses: jlumbroso/free-disk-space@main
18+
with:
19+
tool-cache: false
20+
1621
- name: Checkout
1722
uses: actions/checkout@v6
1823

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The core networking is delegated to a QUIC library but the rest is in applicatio
2121
- 🎯 **Multi-language** with both Rust (native) and TypeScript (web) libraries.
2222
- 🔧 **Generic** for any live data, not just media. Includes text chat as both an example and a core feature.
2323

24-
> **Note:** This project implements [moq-lite](https://doc.moq.dev/concept/layer/moq-lite), a forwards-compatible subset of the IETF [moq-transport](https://datatracker.ietf.org/doc/draft-ietf-moq-transport/) draft. moq-lite works with any moq-transport CDN (ex. [Cloudflare](https://doc.moq.dev/blog/first-cdn)). The focus is narrower, prioritizing simplicity and deployability.
24+
> **Note:** This project implements [moq-lite](https://doc.moq.dev/concept/layer/moq-lite), a forwards-compatible subset of the IETF [moq-transport](https://datatracker.ietf.org/doc/draft-ietf-moq-transport/) draft. moq-lite works with any moq-transport CDN (ex. [Cloudflare](https://moq.dev/blog/first-cdn/)). The focus is narrower, prioritizing simplicity and deployability.
2525
2626
## Demo
2727

@@ -107,7 +107,7 @@ Think of `hang` as like HLS/DASH, while `moq-lite` is like HTTP.
107107

108108
## Libraries
109109

110-
This repository provides both [Rust](/rs) and [TypeScript](/js) libraries with similar APIs but language-specific optimizations.
110+
This repository provides both [Rust](rs) and [TypeScript](js) libraries with similar APIs but language-specific optimizations.
111111

112112
### Rust
113113

@@ -128,7 +128,7 @@ This repository provides both [Rust](/rs) and [TypeScript](/js) libraries with s
128128
| Package | Description | NPM |
129129
|------------------------------------------|--------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
130130
| **[@moq/lite](js/lite)** | The core pub/sub transport protocol. Intended for browsers, but can be run server-side with a WebTransport polyfill. | [![npm](https://img.shields.io/npm/v/@moq/lite)](https://www.npmjs.com/package/@moq/lite) |
131-
| **[@moq/token](js/token)** | Authentication library & CLI for JS/TS environments (see [Authentication](doc/concept/authentication.md)) | [![npm](https://img.shields.io/npm/v/@moq/token)](https://www.npmjs.com/package/@moq/token) |
131+
| **[@moq/token](js/token)** | Authentication library & CLI for JS/TS environments (see [Authentication](doc/app/relay/auth.md)) | [![npm](https://img.shields.io/npm/v/@moq/token)](https://www.npmjs.com/package/@moq/token) |
132132
| **[@moq/hang](js/hang)** | Core media library: catalog, container, and support. Shared by `@moq/watch` and `@moq/publish`. | [![npm](https://img.shields.io/npm/v/@moq/hang)](https://www.npmjs.com/package/@moq/hang) |
133133
| **[@moq/demo](demo/web)** | Examples using `@moq/hang`. | |
134134
| **[@moq/watch](js/watch)** | Subscribe to and render MoQ broadcasts (Web Component + JS API). | [![npm](https://img.shields.io/npm/v/@moq/watch)](https://www.npmjs.com/package/@moq/watch) |
@@ -139,7 +139,7 @@ This repository provides both [Rust](/rs) and [TypeScript](/js) libraries with s
139139

140140
Additional documentation and implementation details:
141141

142-
- **[Authentication](doc/concept/authentication.md)** - JWT tokens, authorization, and security
142+
- **[Authentication](doc/app/relay/auth.md)** - JWT tokens, authorization, and security
143143

144144
## Protocol
145145

@@ -170,7 +170,7 @@ just pub tos # Terminal 2: Publish a demo video using ffmpeg
170170
just web # Terminal 3: Start web server
171171
```
172172

173-
There are more commands: check out the [justfile](justfile), [rs/justfile](rs/justfile), and [js/justfile](js/justfile).
173+
There are more commands: check out the [justfile](justfile).
174174

175175
## Iroh support
176176

js/hang/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ import * as Publish from "@moq/publish";
6262

6363
Licensed under either:
6464

65-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
66-
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
65+
- Apache License, Version 2.0 ([LICENSE-APACHE](../../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
66+
- MIT license ([LICENSE-MIT](../../LICENSE-MIT) or http://opensource.org/licenses/MIT)

js/lite/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `@moq/lite` client specifically implements the networking layer called [moq-
1212

1313
Check out [hang](../hang) for a higher-level media library that uses this package.
1414

15-
> **Note:** moq-lite is a subset of the IETF [moq-transport](https://datatracker.ietf.org/doc/draft-ietf-moq-transport/) draft. moq-lite is forwards compatible with moq-transport, so it works with any moq-transport CDN (ex. [Cloudflare](https://doc.moq.dev/blog/first-cdn)). See the [compatibility docs](https://doc.moq.dev/concept/layer/moq-lite#compatibility) for details.
15+
> **Note:** moq-lite is a subset of the IETF [moq-transport](https://datatracker.ietf.org/doc/draft-ietf-moq-transport/) draft. moq-lite is forwards compatible with moq-transport, so it works with any moq-transport CDN (ex. [Cloudflare](https://moq.dev/blog/first-cdn/)). See the [compatibility docs](https://doc.moq.dev/concept/layer/moq-lite#compatibility) for details.
1616
1717
## Quick Start
1818

@@ -66,5 +66,5 @@ await quicheLoaded; //This is a promise, connect after it resolves
6666

6767
Licensed under either:
6868

69-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
70-
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
69+
- Apache License, Version 2.0 ([LICENSE-APACHE](../../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
70+
- MIT license ([LICENSE-MIT](../../LICENSE-MIT) or http://opensource.org/licenses/MIT)

js/token/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# moq-token
22

3-
A Javascript/Typescript library and CLI for implementing authentication with a MoQ relay. For comprehensive documentation including token structure, authorization rules, and examples, see the [Authentication Documentation](../../doc/concept/authentication.md)
3+
A Javascript/Typescript library and CLI for implementing authentication with a MoQ relay. For comprehensive documentation including token structure, authorization rules, and examples, see the [Authentication Documentation](../../doc/app/relay/auth.md)
44

55
## Installation
66

js/ui-core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ Shared stylesheets are available as CSS imports:
3737

3838
Licensed under either:
3939

40-
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
41-
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
40+
- Apache License, Version 2.0 ([LICENSE-APACHE](../../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
41+
- MIT license ([LICENSE-MIT](../../LICENSE-MIT) or http://opensource.org/licenses/MIT)

justfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ ci:
8787
cargo check --workspace --all-features
8888

8989
# Check for broken links
90-
lychee --root-dir "$(pwd)/doc" doc
91-
lychee --exclude-path doc .
90+
lychee --root-dir "$(pwd)/doc" --fallback-extensions md doc
91+
lychee --exclude-path doc --exclude-path "CHANGELOG\\.md" --exclude-path "demo/web/src/.*\\.html" .
9292

9393
# Dry-run publish to verify packaging
9494
cargo publish --dry-run

lychee.toml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Exclude localhost URLs (intentional for dev docs)
22
exclude_loopback = true
33

4-
# Don't check auto-generated changelogs
5-
exclude_path = ["CHANGELOG.md"]
4+
# Don't check auto-generated changelogs or Vite-served HTML (root-relative paths)
5+
exclude_path = ["CHANGELOG\\.md", "demo/web/src/.*\\.html"]
6+
7+
# Accept 403 status codes (npmjs.com, linode.com block automated requests)
8+
accept = [200, 403]
9+
10+
# Exclude URLs that are frequently unreachable in CI
11+
exclude = [
12+
"https://nixos.org",
13+
"https://letsencrypt.org",
14+
# Repo no longer exists
15+
"https://github.com/n0-computer/iroh-live",
16+
]

rs/moq-lite/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Documentation](https://docs.rs/moq-lite/badge.svg)](https://docs.rs/moq-lite/)
22
[![Crates.io](https://img.shields.io/crates/v/moq-lite.svg)](https://crates.io/crates/moq-lite)
3-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE-MIT)
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](../../LICENSE-MIT)
44

55
# moq-lite
66

rs/moq-relay/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Cluster arguments:
5656
The relay supports JWT-based authentication and authorization with path-based access control.
5757

5858
For detailed authentication setup, including token generation and configuration examples, see:
59-
**[Authentication Documentation](../../docs/auth.md)**
59+
**[Authentication Documentation](../../doc/app/relay/auth.md)**
6060

6161
Key features:
6262

0 commit comments

Comments
 (0)