Skip to content
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

docs: Improve typography documentation [OR-730] #1723

Merged
merged 4 commits into from
Jun 18, 2024
Merged

docs: Improve typography documentation [OR-730] #1723

merged 4 commits into from
Jun 18, 2024

Conversation

notlee
Copy link
Contributor

@notlee notlee commented Jun 14, 2024

  • Use one mdx file, to avoid duplicate content to manage
  • Add SV editorial typography guidelines
  • Display customisation options and code example
  • Place type scales behind tabs, to avoid endless scrolling.
  • Show a code snippet with copy button for type scales.

- Use one mdx file, to avoid duplicate content to manage
- Add SV editorial typography guidelines
- Add a new Preview code snippet to highlight allowed customisations (I do not love that this shows what could be, rather than what is in the demo, but it's the best idea I have for showing this kind of option right now).
- Place type scales behind tabs, to avoid endless scrolling.
- Show a code snippet with copy button for type scales.
@notlee notlee requested a review from a team as a code owner June 14, 2024 15:58
@origamiserviceuser origamiserviceuser added this to Backlog in Origami ✨ Jun 14, 2024
@notlee notlee changed the title docs: Improve typography documentation docs: Improve typography documentation [OR-730] Jun 14, 2024
@notlee notlee temporarily deployed to origami-webs-sv-typogra-nvuotx June 14, 2024 16:04 Inactive
The preview code should show only code for the preview, not hypothetical extras. The customisation options should also be visible to designers
@notlee notlee temporarily deployed to origami-webs-sv-typogra-nvuotx June 14, 2024 16:34 Inactive
@notlee notlee temporarily deployed to origami-webs-sv-typogra-nvuotx June 14, 2024 16:37 Inactive
we would not expect any other way for editorial typography
@notlee notlee temporarily deployed to origami-webs-sv-typogra-nvuotx June 14, 2024 16:43 Inactive
@notlee notlee merged commit 51e9406 into main Jun 18, 2024
7 checks passed
Origami ✨ automation moved this from Backlog to Done Jun 18, 2024
@notlee notlee deleted the sv-typography branch June 18, 2024 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Origami ✨
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants