docs: clean up HTML helpers documentation #189
Merged
+256
−48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove all code references and links to old source paths from the HTML helpers documentation. All documented functions (attr, css, js, sanitize, ul, ol, thumbnailImage) are validated and working with 24 passing tests.
- Add clear input/output examples for all 7 helpers - Show single and multiple value usage for css and js helpers - Add practical examples for sanitize (XSS prevention) - Add complete examples for ul and ol block helpers - Document all thumbnailImage properties with real-world examples - Fix incorrect parameter documentation (context.src -> context.thumbnail) - Use consistent formatting with handlebars and html code blocks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #189 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 23 23
Lines 1172 1172
Branches 301 301
=========================================
Hits 1172 1172 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: edfca3c962
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
CoffeeScript is outdated and no longer commonly used.
The sanitize helper uses striptags which removes HTML tags but preserves all text content. Updated the example to show a realistic use case and added a note clarifying it's not a security sanitizer for untrusted input.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Remove all code references and links to old source paths from the HTML
helpers documentation. All documented functions (attr, css, js, sanitize,
ul, ol, thumbnailImage) are validated and working with 24 passing tests.