Skip to content

Provide an official PDF download for the Spring AI reference documentation #4659

@rhm002

Description

@rhm002

Description

The Spring AI reference documentation is currently available only as HTML at
https://docs.spring.io/spring-ai/reference/. Unlike many other Spring projects (Spring Boot, Spring Framework, Spring Data, …) there is no “PDF” button or downloadable spring‑ai‑reference.pdf file.

Why a PDF is needed

  • Offline reading – many developers work in environments without reliable internet access (air‑gapped labs, conference Wi‑Fi, etc.).
  • Print‑friendly – teams often print the docs for quick reference or for internal training.
  • Parity with other Spring projects – a PDF link already exists for Spring Boot, Spring Framework, Spring Data, etc.; having a PDF for Spring AI would keep the documentation experience consistent across the Spring ecosystem.
  • Stable citation – a fixed‑version PDF provides a stable reference for books, blogs and academic papers.

Suggested implementation

The Spring AI docs are written in AsciiDoc (spring-ai-docs/src/main/asciidoc/).

  • Add a Gradle/Maven task (similar to the one used for other Spring projects) that generates spring-ai-reference.pdf from the AsciiDoc sources.
  • Publish the file alongside the HTML docs at
    https://docs.spring.io/spring-ai/reference/pdf/spring-ai-reference.pdf
    (the same URL pattern used by other Spring projects).
  • Update the docs navigation bar to show a small “PDF” link/icon, as done for Spring Boot and Spring Framework.

Affected version(s)

Request applies to the current stable release (e.g. 1.1.x) and all future releases.

Additional context

Desired outcome

  • A PDF download link that works for every released version of Spring AI.
  • Optionally, the PDF should be included in the Maven Central “spring‑ai‑docs” artifact so users can fetch it with mvn dependency:get -Dartifact=org.springframework.ai:spring-ai-docs:1.1.0:pdf.

Thank you for considering this request!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions