ignite icon indicating copy to clipboard operation
ignite copied to clipboard

Docs: Add screenshots of each component in docs

Open jamonholmgren opened this issue 1 year ago • 1 comments
trafficstars

It would be really nice to have screenshots of each component, maybe right below the code snippet. Should be relatively simple to add. I recommend hosting the images in here OR just uploading them to this issue and capturing the URL.

CleanShot 2024-04-22 at 12 33 46@2x

https://github.com/infinitered/ignite/issues/2667#issuecomment-2070773338_

jamonholmgren avatar Apr 22 '24 19:04 jamonholmgren

@jamonholmgren / @yulolimum Do you have any suggestions on good screenshot taking for such a thing? I'd normally just ctrl+cmd+shift+4 but they won't be framed nice or even sized I guess.

Or we could just screenshot the showroom screen part of each one I guess

frankcalise avatar Apr 30 '24 01:04 frankcalise

Hello @frankcalise , @jamonholmgren I wonder if someone is already working on this issue? I would like to contribute to it , this would be my idea to share the screenshot for the different components. I was thinking to get them from the app template and share them in a simulator. what do you think or what are your ideas ? simulator_screenshot_90427CE0-ACA5-44E7-BBCB-9B84699BE308-portrait

jmejiamu avatar Jul 01 '24 03:07 jmejiamu

@jmejiamu hey thanks for your interest! you are free to take a go at this one.

How they appear in the simulator is fine. I'm thinking maybe in isolation perhaps so other components on the screen don't confuse users.

Other than that, just keep them consistent throughout the documentation so it has a nice feel to it and users know where to look/what to expect.

You will have to also clone down https://github.com/infinitered/ir-docs if you want to see them work locally as they were hosted at https://docs.infinite.red - let us know if you have any issues.

frankcalise avatar Jul 03 '24 02:07 frankcalise

@jmejiamu are you working on this?

frankcalise avatar Aug 11 '24 14:08 frankcalise

@frankcalise I did.I submitted a PR. Here it is the PR, but I was not able to add a reviewer nor assigned to me. Please let me if that fine or not. I am more than happy to redo it if that's the case. :)

jmejiamu avatar Aug 11 '24 17:08 jmejiamu

Ah ok, the docs that should be modified belong in this tepo, not ir-docs.

Sorry for the confusion, you just needed to clone that repo and link these docs so you could see your changes as you would view the doc site

frankcalise avatar Aug 11 '24 17:08 frankcalise

@frankcalise I see, sorry I got confused. I will modify work on that again.

jmejiamu avatar Aug 11 '24 17:08 jmejiamu

:tada: This issue has been resolved in version 9.8.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

infinitered-circleci avatar Aug 13 '24 12:08 infinitered-circleci