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(tutorial/api-fetching): improve text and snippet code #40

Merged
merged 4 commits into from
Mar 1, 2025

Conversation

nicolasgasco
Copy link
Contributor

@nicolasgasco nicolasgasco commented Feb 27, 2025

Related issue

None

Overview

With this small PR, I'd like to introduce some small tweaks to text of the API fetching page of the tutorial.

Some of the changes are typo and grammar fixes, while some others are more subjective, but they all contribute (at least in my opinion) to making the page more pleasant to read.

I included a small tweak to the tsx snippet as well in order to:

  • render the Pokemons list in a more pleasant way (see below)
  • avoid using index for key, since it's not considered a good practice and the Pokemons names are a better candidate
Before After
Screenshot 2025-02-27 at 23 16 48 Screenshot 2025-02-27 at 23 16 22

@nicolasgasco nicolasgasco changed the title Small improvements to api-fetching.mdx Text and snippet improvements to api-fetching.mdx Feb 27, 2025
@nicolasgasco nicolasgasco force-pushed the patch-1 branch 2 times, most recently from d0e5bd7 to 33ded3f Compare February 27, 2025 22:25
@nicolasgasco nicolasgasco marked this pull request as ready for review February 27, 2025 22:26
@jacobhq jacobhq added the enhancement New feature or request label Feb 27, 2025
@jacobhq jacobhq self-requested a review February 27, 2025 23:26
@jacobhq jacobhq changed the title Text and snippet improvements to api-fetching.mdx chore: Text and snippet improvements to api-fetching.mdx Feb 27, 2025
@marcalexiei marcalexiei changed the title chore: Text and snippet improvements to api-fetching.mdx feat(tutorial/api-fetching): improve text and snippet code Feb 28, 2025
@marcalexiei marcalexiei self-requested a review February 28, 2025 03:33
marcalexiei

This comment was marked as resolved.

@Valerioageno
Copy link
Member

Thanks @nicolasgasco!
FYI we need to fix this bug on tuono before merging this PR...

@jacobhq

This comment was marked as resolved.

@nicolasgasco
Copy link
Contributor Author

Thanks for your contribution. I like the way you improved the text on this page!

I left a few suggestion, let me know what do you think about them!

Also please fix the format check by running:

pnpm run format:fix

@marcalexiei it's not raising any diff when I run it 🤔

@nicolasgasco nicolasgasco force-pushed the patch-1 branch 3 times, most recently from c886cc5 to 110a82d Compare February 28, 2025 19:10
@marcalexiei
Copy link
Member

it's not raising any diff when I run it 🤔

It seems like you’ve changed the code, so the formatting error is no longer present.
The CI was failing as you can see in this run.


Side note: Could you please avoid using force pushes in the future?
They make incremental reviews more difficult (https://tuono.dev/documentation/contributing/pull-requests#overview)

Copy link
Member

@jacobhq jacobhq left a comment

Choose a reason for hiding this comment

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

Nice work here. I've added a few suggestions just to make it a bit smoother to read, but apart from that, looks great!

@nicolasgasco
Copy link
Contributor Author

Side note: Could you please avoid using force pushes in the future?
They make incremental reviews more difficult (https://tuono.dev/documentation/contributing/pull-requests#overview)

@marcalexiei Absolutely, sorry for that!

Copy link
Member

@marcalexiei marcalexiei left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks again for your work on this.

When you have the change check #42 🚀

Copy link
Member

@jacobhq jacobhq left a comment

Choose a reason for hiding this comment

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

Thanks!

@Valerioageno Valerioageno merged commit bf3baef into tuono-labs:main Mar 1, 2025
4 checks passed
@nicolasgasco nicolasgasco changed the title feat(tutorial/api-fetching): improve text and snippet code docs(tutorial/api-fetching): improve text and snippet code Mar 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants