Skip to content

Commit 69dfcc1

Browse files
committed
Check for broken links
Signed-off-by: David Gageot <david.gageot@docker.com>
1 parent 48d9c10 commit 69dfcc1

4 files changed

Lines changed: 37 additions & 3 deletions

File tree

Taskfile.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,40 @@ tasks:
9898
docker-agent-docs \
9999
jekyll serve --host 0.0.0.0 --config _config.yml,_config.dev.yml --livereload
100100
101+
docs-check-links:
102+
desc: Build the documentation site and check for broken links
103+
dir: docs
104+
cmd: |
105+
cleanup() {
106+
docker rm -f docs-linkcheck 2>/dev/null
107+
docker network rm docs-linkcheck-net 2>/dev/null
108+
}
109+
trap cleanup EXIT
110+
111+
docker build -t docker-agent-docs . && \
112+
docker network create docs-linkcheck-net && \
113+
docker run -d --rm \
114+
--name docs-linkcheck \
115+
--network docs-linkcheck-net \
116+
-v "{{.TASKFILE_DIR}}/docs:/srv/jekyll" \
117+
docker-agent-docs \
118+
jekyll serve --host 0.0.0.0 --config _config.yml,_config.dev.yml && \
119+
echo 'Waiting for Jekyll to start...' && \
120+
for i in $(seq 1 30); do \
121+
docker run --rm --network docs-linkcheck-net curlimages/curl -sf http://docs-linkcheck:4000/ > /dev/null 2>&1 && break; \
122+
sleep 2; \
123+
done && \
124+
docker run --rm \
125+
--network docs-linkcheck-net \
126+
raviqqe/muffet \
127+
--buffer-size 16384 \
128+
--exclude 'fonts.googleapis.com' \
129+
--exclude 'fonts.gstatic.com' \
130+
--exclude 'console.mistral.ai' \
131+
--exclude 'console.x.ai' \
132+
--rate-limit 20 \
133+
http://docs-linkcheck:4000/
134+
101135
record-demo:
102136
desc: Record demo gif
103137
cmd: vhs ./docs/recordings/demo.tape

docs/community/contributing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ _docker-agent is open source. Here's how to set up your development environment
1515
- [Go 1.26](https://go.dev/dl/) or higher
1616
- API key(s) for your chosen AI provider
1717
- [Task 3.44](https://taskfile.dev/installation/) or higher
18-
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/#binaries)
18+
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/local/)
1919

2020
<div class="callout callout-info">
2121
<div class="callout-title">ℹ️ Platform Support

docs/features/a2a/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ _Expose docker-agent agents via Google's Agent-to-Agent (A2A) protocol for inter
1010

1111
## Overview
1212

13-
The `docker agent serve a2a` command starts an A2A server that exposes your agents using the [A2A protocol](https://google.github.io/A2A/). This enables communication between Docker Agent and other agent frameworks that support A2A.
13+
The `docker agent serve a2a` command starts an A2A server that exposes your agents using the [A2A protocol](https://a2a-protocol.org/latest/). This enables communication between Docker Agent and other agent frameworks that support A2A.
1414

1515
<div class="callout callout-warning">
1616
<div class="callout-title">⚠️ Early support

docs/getting-started/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ For the latest features, or to contribute, build from source:
7373

7474
- [Go 1.26](https://go.dev/dl/) or higher
7575
- [Task 3.44](https://taskfile.dev/installation/) or higher (build tool)
76-
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/#binaries) (for linting)
76+
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/local/) (for linting)
7777

7878
```bash
7979
# Clone the repository

0 commit comments

Comments
 (0)