Skip to content

Commit f87a609

Browse files
authored
CLAUDE.md + fix broken link (#241)
* Add CLAUDE.md * Exclude CLAUDE.md from being served * 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. Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Tom Bentley <tbentley@redhat.com>
1 parent 5bd7383 commit f87a609

3 files changed

Lines changed: 24 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
This is the repo for the website associated with Kroxylicious.
2+
Kroxylicious is a Layer 7 proxy for the Kafka protocol.
3+
The website uses Jekyll and is hosted on github.
4+
5+
The content in this repo is a mixture of two things:
6+
7+
* static markdown and HTML content, which doesn't change much between releases of the Kroxylicious software.
8+
* version-specific documentation, where a new release of the Kroxylicious software produces new documentation about that version.
9+
10+
The version-specific content has index pages enumerating the downloads and documentation publications, which is templated using liquid templates.
11+
12+
When you make a change you should test it.
13+
The script `./run.sh` can be used to serve the site from a docker container.
14+
The preview site can then be accessed at `http://127.0.0.1:4000/`.
15+
16+
This GitHub repository is hosted on GitHub at `https://github.com/kroxylicious/kroxylicious.github.io`.
17+
You can use the `gh` tool to interact with GitHub PRs.
18+
Note that we do not use the website repo for issues.
19+
Instead, issues for the website are held in the main Kroxylicious repo `https://github.com/kroxylicious/kroxylicious`.
20+
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`.
21+
22+
When making commits, use the `Assisted-by:` trailer to attribute changes to AI tooling, rather than `Coauthored-by:`.

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ exclude:
5151
- run.sh
5252
- bootstrap_setup.sh
5353
- README.md
54+
- CLAUDE.md
5455
# - .sass-cache/
5556
# - .jekyll-cache/
5657
# - gemfiles/

_data/documentation/0_19_0.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,5 +79,5 @@ docs:
7979
description: The Java API documentation.
8080
tags:
8181
- developer
82-
path: "https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/${project.version}/index.html"
82+
path: https://javadoc.io/doc/io.kroxylicious/kroxylicious-api/0.19.0/index.html
8383
rank: '033'

0 commit comments

Comments
 (0)