-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BD-3318-5 Apply Diataxis standards to Liquid documentation #8219
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md
Outdated
Show resolved
Hide resolved
@@ -185,10 +175,27 @@ Find yourself assigning the same variables in every message? Instead of writing | |||
As long as the Content Block is at the top of your message, every time the variable is inserted into your message as an object, it will refer to your chosen custom attribute! | |||
{% endalert %} | |||
|
|||
### Use case |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have any standards around naming "Use case" headers so we don't have the same header multiple times on the page? It might help with SEO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll update the templates, but I've been using "Use Case" for one-off use cases that are nested under specific headers, as it's implied that the use case is for that header (in this case, variable tags). For multiple use cases that are nested under the same header, I've been using "Use Case: So-and-So". I think "Use Case #" has been used in the past.
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/using_liquid.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/using_liquid.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/using_liquid.md
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/using_liquid.md
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments! These are good improvements, though. Approving so I'm not a blocker.
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/using_liquid.md
Outdated
Show resolved
Hide resolved
_docs/_user_guide/personalization_and_dynamic_content/liquid/supported_personalization_tags.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Josh McCrowell <113209750+josh-mccrowell-braze@users.noreply.github.com>
Why are you making this change? (required)
Apply Diataxis standards and brand voice to three Liquid articles/pages.
Related PRs, issues, or features (optional)
Feature release date (optional)
BD-3318
Contributor checklist
Submitting for review
If your PR meets the above requirements, select Ready for review, then add a reviewer:
braze-inc/docs-team
as the reviewer.braze-inc/docs-team
instead.Thanks for contributing! We look forward to reading your work.