search

infinitered / ignite

Infinite Red's battle-tested React Native project boilerplate, along with a CLI, component/model generators, and more! 9 years of continuous development and counting.
MIT License
17.69k stars 1.4k forks source link

Docs: Add screenshots of each component in docs #2671

Closed jamonholmgren closed 3 months ago

jamonholmgren commented 6 months ago

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_

frankcalise commented 6 months ago

@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

jmejiamu commented 4 months ago

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

frankcalise commented 4 months ago

@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 commented 3 months ago

@jmejiamu are you working on this?

jmejiamu commented 3 months ago

@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. :)

frankcalise commented 3 months ago

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

jmejiamu commented 3 months ago

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

infinitered-circleci commented 3 months ago

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

The release is available on:

Your semantic-release bot :package::rocket: