Skip to content

Fix Java template documentation - #439

Closed
welteki wants to merge 1 commit into
openfaas:masterfrom
welteki:docs/fix-java-templates
Closed

welteki wants to merge 1 commit into
openfaas:masterfrom
welteki:docs/fix-java-templates

Fix Java template documentation

0b3939d
Select commit
Loading
Failed to load commit list.
reviewfn / AI Code Review succeeded Sep 25, 2026 in 1m 9s

AI Code Review Results

AI Pull Request Overview

Disclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification.

Summary

  • Documentation-only change scoped to the Java section of the template guide.
  • Updates the documented Classic Java template set to include java17.
  • Corrects the Vert.x template name from java11-vertx to java11-vert-x.
  • Updates the scaffold example to use java17.
  • Corrects generated source and test paths for the Java template layout.
  • No blocking correctness, rendering, reproducibility, or publish-quality issues found in the scoped diff.

Approval rating (1-10)

9/10. The changes are narrow, accurate within the surrounding documentation, and improve reader reproducibility without introducing visible rendering risk.

Summary per file

Summary per file
File path Summary
docs/cli/templates.md Updates Java template names, scaffold example, and generated project paths.

Overall Assessment

The PR aligns the Java template documentation with the template names and generated layout referenced by the updated guide. The edits are focused and make the examples more reproducible for readers creating Java functions. I did not find a concrete issue that should block publication.

Detailed Review

Detailed Review

Content review

No blocking findings.

  • The section title and surrounding flow remain appropriate: the Java subsection still sits under Classic templates, and the new sentence clearly lists the available Java options.
  • The primary example now uses java17, which matches the stated goal of making the current Java template the default example for readers.
  • The corrected java11-vert-x spelling is consistent with the template-store example earlier in the same page.
  • The source and test paths are specific enough for readers to locate the generated files after scaffolding and do not introduce Markdown rendering concerns.

AI agent details.

Agent processing time: 1m4.709s
Environment preparation time: 3.599s
Total time from webhook: 1m13.345s