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: rephrase docs and readme #1912

Merged
merged 7 commits into from Mar 9, 2023
Merged

docs: rephrase docs and readme #1912

merged 7 commits into from Mar 9, 2023

Conversation

ghost
Copy link

@ghost ghost commented Mar 6, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Most of the "Getting started" sections contain verbose and redundant sentences, one of them was:

"x is a composable function. Calling that composable function [...]"

I've shortened it while making sure it's understandable enough; I've also proofread and rephrased a lot of sentences on the Basic Usage page and changed nuxt.config file extensions from .js to .ts since the v8 docs it's mainly focused on Nuxt 3.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@BobbieGoede
Copy link
Collaborator

Looks like good and needed changes overall!

I agree that the composable descriptions are a bit verbose, but I have to point out that the updated description could cause some confusion.

`useLocalePath` is a composable that returns the localized URL for a given page.

Would be more correct if it were the following:

`useLocalePath` is a composable which returns a function used to get the localized URL for a given page.

Something along those lines, and same goes for the other composables described on that page.

@kazupon
Copy link
Collaborator

kazupon commented Mar 9, 2023

Thank you for your contribution!
Looks good for me!

Please update the part commented by BobbieGoede on in the review as well. πŸ™

@kazupon kazupon merged commit 4aeeeec into nuxt-modules:next Mar 9, 2023
4 checks passed
DarthGigi pushed a commit to DarthGigi/i18n that referenced this pull request Apr 16, 2024
* Rephrase warning note

* fix(docs): rephrase basic usage

* Add spaces in vue code blocks

* typo: "documentation"

* fix readme typo

* update composable sentences + minor changes
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.

None yet

2 participants