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

Content Guidance dynamic images #253

Open
Tracked by #473 ...
PtitBen opened this issue Nov 6, 2023 · 5 comments
Open
Tracked by #473 ...

Content Guidance dynamic images #253

PtitBen opened this issue Nov 6, 2023 · 5 comments
Labels
Area: Discovery Getting an understanding to do a piece of work Status: On Hold Awaiting for clarification or another issue to be resolved

Comments

@PtitBen
Copy link
Contributor

PtitBen commented Nov 6, 2023

Discovery of an option to dynamically generate the main guidance images for each component, perhaps utilising some sort of tooltip interaction. This could make updating somewhat more automated and less time consuming.

If it is deemed too complex for this first iteration we can revert to using the existing images. These should also be assessed and adusted if necessary for exclusion zones to ensure an appropriate experience on both light and dark modes in the docs.

@PtitBen PtitBen mentioned this issue Nov 6, 2023
26 tasks
@andij
Copy link
Contributor

andij commented Nov 27, 2023

Having done some research on those 'Product Tour' experiences when first using a web app.

I've found this library: https://lusift.vercel.app/

CodyHouse have this: https://codyhouse.co/ds/components/info/product-tour (but it's paid for) and this: https://github.com/codyhouse/product-tour/tree/master (but it's old)

@RobTobias123
Copy link
Contributor

I've added component/images folders to accordion, alert and card and populated them with a copy of the existing images (latest optimised webps) used in the current version. This will help us assess what needs adjusting (exclusion zones, any instances of old style illustrations etc) as we populate the content and provide a fallback alternative for the dynamic concept should we need it. (Can be removed if we go dynamic for launch).

@RobTobias123 RobTobias123 added this to the Internal tools milestone Nov 27, 2023
@RobTobias123
Copy link
Contributor

PR: #262

@RobTobias123 RobTobias123 changed the title Content Guidance images Content Guidance dynamic images Nov 28, 2023
@PtitBen
Copy link
Contributor Author

PtitBen commented Nov 29, 2023

Dynamic annotation for components and code:

Anatomy for code and component:

image image

And (what seems to be a more complex solution):
(weirdly not working on smaller viewports, maybe just a kink that can be sorted out)
image

Speccer

@andij andij added the Status: On Hold Awaiting for clarification or another issue to be resolved label Dec 4, 2023
@andij
Copy link
Contributor

andij commented Jan 4, 2024

For the initial release we have agreed to reuse the existing Content Guidance annotated screenshot and supporting table.

Removing the heading row and replacing with a heading (level 4) 'Key'.

@andij andij added the Area: Discovery Getting an understanding to do a piece of work label Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Discovery Getting an understanding to do a piece of work Status: On Hold Awaiting for clarification or another issue to be resolved
Projects
None yet
Development

No branches or pull requests

3 participants