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: add component screenshots #2671 #2739

Conversation

jmejiamu
Copy link
Contributor

@jmejiamu jmejiamu commented Aug 11, 2024

Please verify the following:

  • yarn test jest tests pass with new tests, if relevant
  • yarn lint eslint checks pass with new code, if relevant
  • yarn format:check prettier checks pass with new code, if relevant
  • README.md (or relevant documentation) has been updated with your changes

Describe your PR

Title: Add screenshots of each component in docs
Closes #2671

Summary:
This pull request adds images for each component in the documentation to make the sample code more understandable.

Details:
Adding images for each component improve the clarity and comprehensibility of the documentation.

Implementation:

Added images illustrating each component to the relevant sections of the documentation.
Updated the markdown files to include the added images next to the corresponding sample code.
Ensure the images looks great in dark or light background.

@frankcalise frankcalise changed the title update(docs):Docs/Add-screenshots-of-each-component-in-docs-#2671 docs: add component screenshots #2671 Aug 12, 2024
Copy link
Contributor

@frankcalise frankcalise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution!

@frankcalise frankcalise merged commit e2bd8a0 into infinitered:master Aug 13, 2024
1 check passed
@infinitered-circleci
Copy link

🎉 This PR is included in version 9.8.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

lindboe added a commit that referenced this pull request Aug 28, 2024
* docs: Add a contributing home page (#2718 by @lindboe)

[skip ci]

* Add a contributing home page

This entry point is intended for quick instruction on how to accomplish
development tasks, and then links out to deeper guides on contributing
from there.

Not sure why I had to add that full path to _category_.json when that wasn't
there before, but this was the only way to make it work locally with ir-docs

* Link to contributing docs from README

* Shorter path

Earlier test failed because IDs are case-sensitive and the casing on the
article didn't match Tour-of-Ignite

---------

Co-authored-by: Frank Calise <fcalise@gmail.com>

* feat(doc): add repo URL for ir-docs (#2734)

* chore(release): 9.8.0 [skip ci]

# [9.8.0](v9.7.2...v9.8.0) (2024-08-09)

### Features

* **doc:** add repo URL for ir-docs ([#2734](#2734)) ([4f59af8](4f59af8))

* Remove demo patches along with dependencies (#2736)

* Add logic to remove patches for any demo dependencies that are also removed

* Add lint improvement

---------

Co-authored-by: Felipe Peña <felipe@penya.cl>

* docs: add component screenshots (#2739 by @jmejiamu)

Co-authored-by: Frank Calise <fcalise@gmail.com>

* fix(boilerplate): remove GestureHandlerRootView (#2738 by @frankcalise)

[skip ci]

* fix: support component testing (#2740 by @lindboe)

There were some issues with out-of-date config when setting up component
testing for the first time.

This PR removes old configuration that's no longer necessary, and adds
tests to ensure component testing continues to work.

* chore(release): 9.8.1 [skip ci]

## [9.8.1](v9.8.0...v9.8.1) (2024-08-13)

### Bug Fixes

* support component testing ([#2740](#2740) by [@lindboe](https://github.com/lindboe)) ([c7edf45](c7edf45))
* **boilerplate:** remove GestureHandlerRootView ([#2738](#2738) by [@frankcalise](https://github.com/frankcalise)) ([437e755](437e755))

* docs: add Robin's CR 2024 talk link (#2741 by @frankcalise)

Co-authored-by: Jamon Holmgren <code@jamon.dev>
[skip ci]

* fix(cli): address outdated pkg vulnerabilities (#2733 by @frankcalise)

[skip ci]

* fix(cli): address outdated pkg vulnerabilities

* fix(cli): fix sharp

* fix(boilerplate): upgrade i18n-js (#2735 by @lindboe and @frankcalise)

* fix(boilerplate): upgrade i18n-js

* fix(boilerplate): i18n jest mock

* docs(intl): update adding languages with doc link

* docs(fix): RTL removal steps

* chore(release): 9.8.2 [skip ci]

## [9.8.2](v9.8.1...v9.8.2) (2024-08-13)

### Bug Fixes

* **boilerplate:** upgrade i18n-js ([#2735](#2735) by [@lindboe](https://github.com/lindboe) and [@frankcalise](https://github.com/frankcalise)) ([a171eae](a171eae))
* **cli:** address outdated pkg vulnerabilities ([#2733](#2733) by [@frankcalise](https://github.com/frankcalise)) ([c06d493](c06d493))

* feat(boilerplate): Make texts on demo components based on i18n (#2721 by @kei95)

* chore(release): 9.9.0 [skip ci]

# [9.9.0](v9.8.2...v9.9.0) (2024-08-20)

### Features

* **boilerplate:** Make texts on demo components based on i18n ([#2721](#2721) by [@kei95](https://github.com/kei95)) ([9695670](9695670))

* docs(boilerplate): Punjabi is not RTL 😅 (#2751 by @jamonholmgren)

Via: https://twitter.com/IndicGames/status/1825949273147716072

* docs: Fixed documentation link in Button (#2755 by @softwarebyze)

* Missed merge conflict

* Update snapshot for v10 format

* Remove vim swap file

* Some prettier fixes

---------

Co-authored-by: Frank Calise <fcalise@gmail.com>
Co-authored-by: Leon Kim <minusnine@gmail.com>
Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
Co-authored-by: Felipe Peña <felipe@penya.cl>
Co-authored-by: Jose Mejia Munoz <jmejiamu@gmail.com>
Co-authored-by: Kei Yamashita <44686790+kei95@users.noreply.github.com>
Co-authored-by: Jamon Holmgren <code@jamon.dev>
Co-authored-by: Zachary Ebenfeld <zackebenfeld@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add screenshots of each component in docs
3 participants