Replies: 1 comment 1 reply
-
See the current version: https://63a2f84bf1071b004effebe4--hods.netlify.app/patterns |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The patterns pages still have the old form of the get in touch guidance in the blue box. They are all a bit different and would benefit from some standardisation. Inspired by the template for component pages, I'd suggest:
Heading 1: Pattern name
One line introduction, followed by examples. For some patterns examples may work better in the how it works section, in particular if there are multiple examples.
Heading 2: When to use this component
More detailed description about how this component solves a problem.
Optional:
Heading 2: When not to use this component
More detailed description about how this component solves a problem.
Heading 2: How it works
Detailed examples showing different ways of using the pattern.
If helpful, include subheadings for different variations of the pattern.
Heading 2: Writing for this component
Describe the best practice for the text used.
Heading 2: Accessibility
Guidance about how to use the component accessibly.
Heading 2: Research
Any research insights, including services currently using the component.
Heading 2: Help improve this component
Link to github discussion about the component, pointing out any known gaps.
Beta Was this translation helpful? Give feedback.
All reactions