From 0ad686b6c02bc2a65cfe01c0f87a599bab7eaa9e Mon Sep 17 00:00:00 2001 From: Tom Bentley Date: Tue, 24 Mar 2026 15:06:23 +1300 Subject: [PATCH 1/5] Add CLAUDE.md Signed-off-by: Tom Bentley --- CLAUDE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..21c188df --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,10 @@ +This is the repo for the website associated with Kroxylicious. +Kroxylicious is a Layer 7 proxy for the Kafka protocol. +The website uses Jekyll and is hosted on github. + +The content in this repo is a mixture of two things: + +* static markdown and HTML content, which doesn't change much between releases of the Kroxylicious software. +* version-specific documentation, where a new release of the Kroxylicious software produces new documentation about that version. + +The version-specific content has index pages enumerating the downloads and documentation publications, which is templated using liquid templates. From f523ee62a05fac30883b22334ad9ac61f9de1ea7 Mon Sep 17 00:00:00 2001 From: Tom Bentley Date: Tue, 24 Mar 2026 15:11:35 +1300 Subject: [PATCH 2/5] Exclude CLAUDE.md from being served Signed-off-by: Tom Bentley --- _config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_config.yml b/_config.yml index 4aba62fa..cb5a03af 100644 --- a/_config.yml +++ b/_config.yml @@ -51,6 +51,7 @@ exclude: - run.sh - bootstrap_setup.sh - README.md + - CLAUDE.md # - .sass-cache/ # - .jekyll-cache/ # - gemfiles/ From c025d69d231e5393ce4d882523b69a65dd9d087a Mon Sep 17 00:00:00 2001 From: Tom Bentley Date: Tue, 24 Mar 2026 15:22:32 +1300 Subject: [PATCH 3/5] Add more to CLAUDE.md Signed-off-by: Tom Bentley --- CLAUDE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 21c188df..084746c3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,3 +8,13 @@ The content in this repo is a mixture of two things: * version-specific documentation, where a new release of the Kroxylicious software produces new documentation about that version. The version-specific content has index pages enumerating the downloads and documentation publications, which is templated using liquid templates. + +When you make a change you should test it. +The script `./run.sh` can be used to serve the site from a docker container. +The preview site can then be accessed at `http://127.0.0.1:4000/`. + +This GitHub repository is hosted on GitHub at `https://github.com/kroxylicious/kroxylicious.github.io`. +You can use the `gh` tool to interact with GitHub PRs. +Note that we do not use the website repo for issues. +Instead, issues for the website are held in the main Kroxylicious repo `https://github.com/kroxylicious/kroxylicious`. +So if you need to interact with website issues you can use the `-R kroxylicious/kroxylicious` option, for example: `gh issue list -R kroxylicious/kroxylicious`. From a8ce23cc386259ef8f701323464196867ef762fe Mon Sep 17 00:00:00 2001 From: Tom Bentley Date: Tue, 24 Mar 2026 15:34:59 +1300 Subject: [PATCH 4/5] Fix broken Javadoc link in 0.19.0 documentation Replace Maven variable ${project.version} with hardcoded version 0.19.0 in the Javadoc URL. The Maven-style placeholder was not being interpolated by Jekyll, causing a broken link on the 0.19.0 documentation page. Fixes kroxylicious/kroxylicious#3526 Assisted-by: Claude Sonnet 4.5 Signed-off-by: Tom Bentley --- _data/documentation/0_19_0.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/documentation/0_19_0.yaml b/_data/documentation/0_19_0.yaml index e8160710..64c0c262 100644 --- a/_data/documentation/0_19_0.yaml +++ b/_data/documentation/0_19_0.yaml @@ -79,5 +79,5 @@ docs: description: The Java API documentation. tags: - developer - path: "https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/${project.version}/index.html" + path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/0.19.0/index.html rank: '033' From 033d4b11c43f05e90486ee72e8ea8aad2cc5b0c2 Mon Sep 17 00:00:00 2001 From: Tom Bentley Date: Tue, 24 Mar 2026 16:09:24 +1300 Subject: [PATCH 5/5] More CLAUDE.md Signed-off-by: Tom Bentley --- CLAUDE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 084746c3..82c877d5 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -18,3 +18,5 @@ You can use the `gh` tool to interact with GitHub PRs. Note that we do not use the website repo for issues. Instead, issues for the website are held in the main Kroxylicious repo `https://github.com/kroxylicious/kroxylicious`. So if you need to interact with website issues you can use the `-R kroxylicious/kroxylicious` option, for example: `gh issue list -R kroxylicious/kroxylicious`. + +When making commits, use the `Assisted-by:` trailer to attribute changes to AI tooling, rather than `Coauthored-by:`.