Add docs for the freemarker templates - #601
Conversation
|
Warning Review limit reached
Next review available in: 57 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (6)
📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds a FreeMarker template-rendering documentation page and links it from the Develop → Transform sidebar. The page covers file-based and inline rendering, template syntax, data access, formatting, escaping, nullable fields, and error handling. ChangesFreeMarker documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with 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.
Inline comments:
In `@en/docs/develop/transform/freemarker.md`:
- Around line 14-16: Update the “Rendering from a file” guidance around
freemarker:renderFromFile to describe disk templates as trusted,
operator-managed server-side code; remove the suggestion that non-developers can
freely edit them and explicitly state that user-supplied template source is
prohibited.
- Around line 25-32: Add ftl to the themeConfig.prism.additionalLanguages list
in docusaurus.config.ts, preserving the existing registered languages. This
enables syntax highlighting for the FreeMarker fences used throughout
freemarker.md.
- Around line 196-204: Add a best-practice entry near the existing formatting
and nullable-field guidance explaining that interpolated untrusted values must
be HTML-escaped with the ?html built-in, or that templates should use an HTML
output format via .ftlh or output_format="HTML". Clarify that render and
renderFromFile otherwise use FreeMarker’s undefined output format and do not
escape values automatically.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: d1c0080b-1813-4ec1-b57e-27176ec3e9b1
⛔ Files ignored due to path filters (6)
en/static/img/develop/transform/freemarker/freemarker-file-read-json.pngis excluded by!**/*.pngen/static/img/develop/transform/freemarker/freemarker-json-variable.pngis excluded by!**/*.pngen/static/img/develop/transform/freemarker/freemarker-print-inline-result.pngis excluded by!**/*.pngen/static/img/develop/transform/freemarker/freemarker-print-result.pngis excluded by!**/*.pngen/static/img/develop/transform/freemarker/freemarker-render-from-file.pngis excluded by!**/*.pngen/static/img/develop/transform/freemarker/freemarker-render-inline.pngis excluded by!**/*.png
📒 Files selected for processing (2)
en/docs/develop/transform/freemarker.mden/sidebars.ts
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with 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.
Inline comments:
In `@en/docs/develop/transform/freemarker.md`:
- Around line 3-4: Update the frontmatter title and corresponding H1 for the
Template Rendering page to include “FreeMarker” while retaining the concise
freemarker URL slug and existing transform path.
- Line 16: Update the documentation text around freemarker:renderFromFile to
avoid claiming JSON separates content from presentation logic entirely; state
that the JSON file separates input data from the template or keeps business
logic outside it, while preserving the existing security guidance.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: a17d9c5e-65e4-4ba2-9b84-50d747eeaa71
📒 Files selected for processing (1)
en/docs/develop/transform/freemarker.md
2350b3b to
9b2752d
Compare
2 participants
Purpose
Summary by CodeRabbit