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: Adds doc about experimental exports (hooks + components) #2192

Merged
merged 12 commits into from
Jan 11, 2024

Conversation

hellofanny
Copy link
Contributor

@hellofanny hellofanny commented Jan 5, 2024

What's the purpose of this pull request?

Adds doc about hooks and components experimental exports. This is a handy tool when customizing components, but it was not explicit in our documentation.

This possibility was introduced previously in #2033

Preview doc: https://faststore-site-git-docs-experimental-exports-hooks-faststore.vercel.app/docs/building-sections/experimental-exports

References

#2033

@hellofanny hellofanny marked this pull request as ready for review January 5, 2024 19:55
@hellofanny hellofanny requested a review from a team as a code owner January 5, 2024 19:55
Copy link

vercel bot commented Jan 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
faststore-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2024 6:25pm

@hellofanny hellofanny requested review from eduardoformiga, lucasfp13, mariana-caetano and a team and removed request for a team January 5, 2024 19:55
Copy link

codesandbox-ci bot commented Jan 5, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 6aa1044:

Sandbox Source
Store UI Typescript Configuration

@hellofanny hellofanny self-assigned this Jan 5, 2024
Copy link
Member

@eduardoformiga eduardoformiga left a comment

Choose a reason for hiding this comment

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

LGTM! ✨

I wonder if would be good to mention this doc in the "Building and Customizing sections" doc.

@hellofanny
Copy link
Contributor Author

LGTM! ✨

I wonder if would be good to mention this doc in the "Building and Customizing sections" doc.

good idea, or we can link it here in the overriding native section 🤔 I'll check with @mariana-caetano :)


- Image_unstable

<Callout type="info" emoji="ℹ️">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eduardoformiga and @mariana-caetano I've added this callout and example of using Image component, can you review it again pls ☺️

Copy link
Member

@eduardoformiga eduardoformiga Jan 10, 2024

Choose a reason for hiding this comment

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

Good Job, @hellofanny.

Since this component comes from the core package instead of components. I think we should give more visibility of how to use it and how it's defined somehow.
https://github.com/vtex/faststore/blob/105a8b2f69ffd8438532d7c9eb959ed26a567675/packages/core/src/components/ui/Image/Image.tsx

Edit: We have this doc https://faststore-git-faststore-images-faststore.vercel.app/how-to-guides/performance/setting-up-faststore-images

It would be good to extract just the relevant information from this doc. (we can do it in another task)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks forms!! Sounds good, for now I've just linked the component to the code 🙈 . But I've added another task just for it.

Copy link
Contributor

@mariana-caetano mariana-caetano left a comment

Choose a reason for hiding this comment

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

Great job, @hellofanny! 🚀

Another suggestion - I believe we've discussed and Formiga also said - is to move this doc to the Building and customizing sections track. This doc will work as a reference guide like the List of Native Sections and Overridable Components.

apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
apps/site/pages/docs/experimental-exports.mdx Outdated Show resolved Hide resolved
@hellofanny
Copy link
Contributor Author

hellofanny commented Jan 11, 2024

Great job, @hellofanny! 🚀

Another suggestion - I believe we've discussed and Formiga also said - is to move this doc to the Building and customizing sections track. This doc will work as a reference guide like the List of Native Sections and Overridable Components.

Thanks Mari! I've moved it to the building and customize section :)

@hellofanny hellofanny merged commit f5bf262 into main Jan 11, 2024
7 checks passed
@hellofanny hellofanny deleted the docs/experimental-exports-hooks branch January 11, 2024 19:31
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

Successfully merging this pull request may close these issues.

3 participants