Skip to content

💄 Tina Docs - Review and redesign embeds #3239

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

Open
10 of 13 tasks
bettybondoc opened this issue Apr 10, 2025 · 8 comments
Open
10 of 13 tasks

💄 Tina Docs - Review and redesign embeds #3239

bettybondoc opened this issue Apr 10, 2025 · 8 comments
Assignees

Comments

@bettybondoc
Copy link

bettybondoc commented Apr 10, 2025

🩸 Pain

The current embeds in Tina Docs feel inconsistent, outdated, and sometimes hard to use. These are what users get out of the box in the Tina Docs package. If they're not polished, users will either tweak them manually or end up with a poor-looking docs site.

🎯 Goal

Make the default embeds in Tina Docs clean, consistent, responsive, and visually polished — so users can use them as-is without needing design or dev tweaks.

💡 Suggested Solution

Redesign each embed component with updated Figma mockups. Follow Tina’s design system and treat these as final, ready-to-ship components. Add notes for edge cases and mobile behaviour where needed.

💼 Tasks

✅ Acceptance Criteria

  1. Each embed has a redesigned Figma mockup
  2. Design is easy used by a range of brands
  3. Works well on desktop and mobile
  4. Notes provided for devs
  5. All designs grouped and clearly labelled in Figma

📸 Screenshots

Image
Figure: Scroll Showcase

Image
Figure: Card Grid

Image
Figure: Youtube Component

Image
Figure: Recipe

Image
Figure: API Reference

Image
Figure: Accordion

Image
Figure: Callouts/Blockquote

Image
Figure: Query-response Block

Cc: @isaaclombardssw @amankumarrr @Marxoz

@bettybondoc bettybondoc self-assigned this Apr 10, 2025
@bettybondoc
Copy link
Author

@isaaclombardssw @Marxoz

Card Grid

Old

card.grid.-.old.mov

New

card.grid.mov

@bettybondoc
Copy link
Author

bettybondoc commented Apr 11, 2025

@isaaclombardssw @Marxoz

Scroll Component (there's a PBI I YakShaved but YakShaver is down 🥲)

Old

Image

New - Desktop

Image

New - Mobile

Image

@bettybondoc
Copy link
Author

@isaaclombardssw @Marxoz

Youtube Caption
(Very tiny - just make it less prominent and adjust spacing)

Old
Image

New
Image

@bettybondoc
Copy link
Author

@isaaclombardssw @Marxoz

API Reference Table

Old -

Screen.Recording.2025-04-17.at.4.20.10.pm.mov

New -

Screen.Recording.2025-04-17.at.4.15.05.pm.mov

@bettybondoc
Copy link
Author

Accordion

Note:

  • Overlay colour not final (I'm not yet happy with the open state of the accordion
  • Expected behaviour: Only open 1 accordion item at a time (open for discussion)

Old -

Screen.Recording.2025-04-17.at.4.22.45.pm.mov

New -

Screen.Recording.2025-04-17.at.4.15.50.pm.mov

@bettybondoc
Copy link
Author

@isaaclombardssw @Marxoz

Callouts

Note: Need to play around shadows and define elevation for different components.

Old -

Image

New -

Image

@bettybondoc
Copy link
Author

Query-Response Blocks

Note:

  • I made the query response code block stacked with preview instead of tabbed so that we can always see the query in relation to the response and also, the long response makes the query have a long unused space at the bottom
  • We can just use the tabbed code component for a different use case (e.g. code snippets in different programming languages)

Old -

Screen.Recording.2025-04-17.at.4.29.23.pm.mov

New -

Screen.Recording.2025-04-17.at.4.16.43.pm.mov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants