Skip to content

Commit a1115b6

Browse files
committed
Add llms.txt for AI assistant discoverability
Add a machine-readable llms.txt at the site root (served from spock-website/public/) following the llmstxt.org spec. It gives LLMs a concise overview of Spock, links to the versioned reference docs index, API, source, and community resources, plus a module reference.
1 parent 78549d7 commit a1115b6

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

spock-website/public/llms.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Spock Framework
2+
3+
> Spock is an enterprise-ready specification and testing framework for Java and Groovy
4+
> applications. Its expressive, BDD-style specification language is highly readable,
5+
> with first-class data-driven testing, powerful built-in mocking/stubbing, and seamless
6+
> JUnit Platform integration so it runs anywhere JUnit does.
7+
8+
Spock specifications are written in Groovy and run on the JVM. The reference documentation
9+
is versioned; the link below is a machine-readable index of every published version.
10+
11+
## Documentation
12+
- [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.
13+
- [Documentation home](https://spockframework.org/spock/docs/): latest reference documentation in the browser.
14+
- [API (Javadoc)](https://spockframework.org/spock/javadoc/current): API documentation for the current release.
15+
16+
## Source & community
17+
- [GitHub repository](https://github.com/spockframework/spock): source code and issue tracker.
18+
- [Example project](https://github.com/spockframework/spock-example): runnable starter project for Gradle and Maven.
19+
- [Discussions](https://github.com/spockframework/spock/discussions): questions and announcements.
20+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/spock): community Q&A under the `spock` tag.
21+
22+
## Optional
23+
- [Try Spock online](https://groovyconsole.dev/?g=groovy_4_0&gist=437e9026ff86d2d709c2c56eb7e2eef1): runnable example in the Groovy web console.
24+
- [Maven Central](https://search.maven.org/search?q=g:org.spockframework): released artifacts.
25+
26+
## Modules
27+
- `spock-core`: the core specification framework — the only dependency most projects need.
28+
- `spock-bom`: bill of materials that aligns the versions of all Spock modules.
29+
- `spock-spring`: integration with Spring's TestContext framework, including Spring Boot test annotations such as `@SpringBootTest` and `@WebMvcTest`.
30+
- `spock-junit4`: support for JUnit 4 rules (`@Rule`/`@ClassRule`).
31+
- `spock-guice`: integration with the Guice dependency-injection container.
32+
- `spock-tapestry`: integration with the Tapestry5 inversion-of-control container.
33+
- `spock-unitils`: integration with the Unitils testing library.
34+
- `spock-testkit`: JUnit Platform Test Kit-based support for testing the Spock execution engine.

0 commit comments

Comments
 (0)