Document authoring of custom Stencil templates#162
Merged
Conversation
Adds Documentation/Templates.md covering configuration, available context (argument, types, macroModel), filters, default templates, a worked example, and caveats. Resolves #157. Also moves Configuration.md and Installation.md into Documentation/ so all non-README docs live in one place, and links README and Configuration.md to the new templates guide.
![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: da8d179c34
ℹ️ 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".
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Resolves #157.
Adds
Documentation/Templates.mddescribing how to author custom Stencil templates for Prefire, including:template_file_pathfor both tests and playbook pluginsargument.*,types.*,macroModel.*with all keys and their typesEmbeddedTemplates.previewTests/previewModelssource as starting points{PREVIEW_FILE_NAME}placeholder,isScreencomparison, cache invalidation)Also moves
Configuration.mdandInstallation.mdintoDocumentation/so all non-README docs live in one place, and links the new templates guide fromREADME.mdandConfiguration.md.