Skip to content

Add llms.txt for AI assistant discoverability #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leonard84 merged 1 commit into from
May 30, 2026
+34 −0
Merged

Add llms.txt for AI assistant discoverability #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions spock-website/public/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Spock Framework

> Spock is an enterprise-ready specification and testing framework for Java and Groovy
> applications. Its expressive, BDD-style specification language is highly readable,
> with first-class data-driven testing, powerful built-in mocking/stubbing, and seamless
> JUnit Platform integration so it runs anywhere JUnit does.

Spock specifications are written in Groovy and run on the JVM. The reference documentation
is versioned; the link below is a machine-readable index of every published version.

## Documentation
- [Reference documentation index](https://spockframework.org/spock/docs/llms.txt): machine-readable index of all documentation versions (latest stable + development snapshot) with a URL template for fetching individual pages as Markdown.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Broken documentation index link on Line 12.

https://spockframework.org/spock/docs/llms.txt currently resolves to 404, so this pointer won’t help agents discover versioned docs. Please update this to a live URL (or defer publishing this link until the target exists).

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@spock-website/public/llms.txt` at line 12, Update the broken documentation
index link in the public/llms.txt content: replace the dead URL
"https://spockframework.org/spock/docs/llms.txt" with a working index URL (or
remove/temporarily comment out the reference) so agents can discover versioned
docs; locate the string in public/llms.txt and either point it to the correct
live docs index or defer publishing that line until the target exists.

Copy link
Copy Markdown
Member Author

@leonard84 leonard84 May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be added by spockframework/spock#2360

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leonard84 Thanks for the context! That makes sense — once spockframework/spock#2360 is merged the URL will be live. Just worth keeping in mind that if this PR lands on master before that companion PR is merged and deployed, the link in llms.txt will temporarily 404 for any agent that crawls it in the interim. If the deployment pipelines are coupled or you plan to merge them together, that's fine.

- [Documentation home](https://spockframework.org/spock/docs/): latest reference documentation in the browser.
- [API (Javadoc)](https://spockframework.org/spock/javadoc/current): API documentation for the current release.

## Source & community
- [GitHub repository](https://github.com/spockframework/spock): source code and issue tracker.
- [Example project](https://github.com/spockframework/spock-example): runnable starter project for Gradle and Maven.
- [Discussions](https://github.com/spockframework/spock/discussions): questions and announcements.
- [Stack Overflow](https://stackoverflow.com/questions/tagged/spock): community Q&A under the `spock` tag.

## Optional
- [Try Spock online](https://groovyconsole.dev/?g=groovy_4_0&gist=437e9026ff86d2d709c2c56eb7e2eef1): runnable example in the Groovy web console.
- [Maven Central](https://search.maven.org/search?q=g:org.spockframework): released artifacts.

## Modules
- `spock-core`: the core specification framework — the only dependency most projects need.
- `spock-bom`: bill of materials that aligns the versions of all Spock modules.
- `spock-spring`: integration with Spring's TestContext framework, including Spring Boot test annotations such as `@SpringBootTest` and `@WebMvcTest`.
- `spock-junit4`: support for JUnit 4 rules (`@Rule`/`@ClassRule`).
- `spock-guice`: integration with the Guice dependency-injection container.
- `spock-tapestry`: integration with the Tapestry5 inversion-of-control container.
- `spock-unitils`: integration with the Unitils testing library.
- `spock-testkit`: JUnit Platform Test Kit-based support for testing the Spock execution engine.
Loading