docs: Grammar overhaul #20636

GalacticHypernova · 2023-05-02T20:06:10Z

Grammatical improvement for the page, with better consistency and punctuation usage.

🔗 Linked issue

Also implements #20706 for a unified merge with the overhaul

❓ Type of change

📖 Documentation (updates to the documentation, readme or JSdoc annotations)
🐞 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)
🧹 Chore (updates to the build process or auxiliary tools and libraries)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR fixes the grammar throughout the documentation, giving a more professional look to nuxt. (As of latest commits, this has become a general-purpose docs PR)

📝 Checklist

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

codesandbox · 2023-05-02T20:06:12Z

Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

nuxt-studio · 2023-05-02T20:06:13Z

✅ Live Preview ready!

Name	Edit	Preview	Latest Commit
Nuxt Docs	Edit on Studio ↗︎	View Live Preview	`00b9eea`

GalacticHypernova · 2023-05-12T15:25:50Z

Done with the sixth batch! Noticed the config documentation is a bit lacking so I will work on it in the meantime, but definitely send the 7th batch whenever you can!

GalacticHypernova · 2023-05-12T15:57:18Z

@danielroe Could I please get a confirmation that my latest commit will, in fact, show autoImport?

danielroe · 2023-05-12T16:12:13Z

packages/schema/src/config/adhoc.ts

+    /**
+     * Toggle auto-imports for all composables, components, directories, and all other parts of your application that Nuxt usually handles.
+     */
+    autoImport: true,


yes, good catch - this will mean it shows up in the nuxt.config generated markdown... You ca n preview the result by running pnpm build:stub (or pnpm build) and checking packages/schema/schema/config.md which will be generated.

It would be good to sync the docs between here and ../src/types/imports so the text and examples are the same.

Alright, thanks for confirming! Turns out preview was indeed the issue in displaying as it did not generate the page when going there, because at first I thought I broke it haha. Always glad to help! Will sync it.

DamianGlowala

Seventh batch of comments

docs/2.guide/2.directory-structure/1.pages.md

docs/2.guide/2.directory-structure/1.plugins.md

docs/2.guide/2.directory-structure/1.server.md

DamianGlowala · 2023-05-12T18:52:04Z

docs/2.guide/2.directory-structure/1.server.md

@@ -149,10 +149,10 @@ export default defineEventHandler(async (event) => {
 You can now universally call this API using `$fetch('/api/submit', { method: 'post', body: { test: 123 } })`.

 ::alert{type=warning title=Attention}
-We are using `submit.post.ts` in the filename only to match requests with `POST` method that can accept the request body. When using `readBody` within a GET request, `readBody` will throw a `405 Method Not Allowed` HTTP error.
+We use `submit.post.ts` in the filename only to match requests with the `POST` method that can accept the request body. When using `readBody` within a GET request, `readBody` will throw a `405 Method Not Allowed` HTTP error.


Suggested change

We use `submit.post.ts` in the filename only to match requests with the `POST` method that can accept the request body. When using `readBody` within a GET request, `readBody` will throw a `405 Method Not Allowed` HTTP error.

We use `submit.post.ts` filename to match requests only with the `POST` method (that can accept the request body). When using `readBody` within a GET request, `readBody` will throw the HTTP `405 Method Not Allowed` response status code.

How about adding a the before submit.post.ts?

docs/2.guide/3.going-further/3.modules.md

DamianGlowala · 2023-05-12T20:24:17Z

docs/2.guide/3.going-further/5.nuxt-app.md

@@ -21,12 +21,12 @@ function useMyComposable () {
 Plugins also receive `nuxtApp` as the first argument for convenience. [Read more about plugins.](/docs/guide/directory-structure/plugins)

 ::alert{icon=👉}
-**`useNuxtApp` (on the server) only works during `setup`, inside Nuxt plugins or `Lifecycle Hooks`**.
+**`useNuxtApp` (on the server) only works during `setup` inside Nuxt plugins or `Lifecycle Hooks`**.


Removing comma changed the meaning of the sentence :)

Also, worth having a look: https://www.proofreadnow.com/blog/putting-only-in-its-place

Suggested change

**`useNuxtApp` (on the server) only works during `setup` inside Nuxt plugins or `Lifecycle Hooks`**.

**`useNuxtApp` (on the server) works only during component's `setup` function, lifecycle hooks and inside Nuxt plugins.**

Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>

danielroe · 2023-05-13T10:06:40Z

This is such a big PR, and therefore could easily get out of sync with main branch.

What do you think about splitting it up into smaller concept-based chunks which can be more easily reviewed and merged in incrementally?

DamianGlowala · 2023-05-13T10:18:13Z

It certainly is, and I am only halfway through the reviewing process. It will be equally time-consuming for anyone to review once we're done with amendments.

I like this idea. Let's wait for what Michael says. We could continue making amendments here until I'm done, and then start splitting this finalised big PR into smaller chunks which can be more easily reviewed.

GalacticHypernova · 2023-05-13T14:27:24Z

If you guys think it would be the smarter idea, I'm down. It's just that I read that docs updates should be grouped and sent as a batch which is what I did. The bigger question here would be how to split this now that it has gotten this big.

Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>

Barbapapazes · 2023-05-13T15:18:45Z

If you guys think it would be the smarter idea, I'm down. It's just that I read that docs updates should be grouped and sent as a batch which is what I did. The bigger question here would be how to split this now that it has gotten this big.

Maybe you could split by folder?

1.getting-started/**
2.guides/1.concepts/**
2.guides/2.directory-structure/**
2.guides/3.going-further/**
3.api/1.composables/**
3.api/2.components/**
3.api/5.commands/**
3.api/**
4.exemples/**
5.community/**
6.bridge/**
7.migration/**

(each item could be a PR)

which will make a good number of pr!

GalacticHypernova · 2023-05-13T18:47:21Z

If you guys think it would be the smarter idea, I'm down. It's just that I read that docs updates should be grouped and sent as a batch which is what I did. The bigger question here would be how to split this now that it has gotten this big.

Maybe you could split by folder?

1.getting-started/**

2.guides/1.concepts/**

2.guides/2.directory-structure/**

2.guides/3.going-further/**

3.api/1.composables/**

3.api/2.components/**

3.api/5.commands/**

3.api/**

4.exemples/**

5.community/**

6.bridge/**

7.migration/**

(each item could be a PR)

which will make a good number of pr!

Hmm, it might be good, but that would mean I'll have to open multiple PR's, wouldn't it? I dont want to be a bother and spam too much. And would I be able to open a PR and just drag and drop the files I have in this branch to each PR accordingly?

Barbapapazes · 2023-05-15T11:53:03Z

If you guys think it would be the smarter idea, I'm down. It's just that I read that docs updates should be grouped and sent as a batch which is what I did. The bigger question here would be how to split this now that it has gotten this big.

Maybe you could split by folder?

1.getting-started/**

2.guides/1.concepts/**

2.guides/2.directory-structure/**

2.guides/3.going-further/**

3.api/1.composables/**

3.api/2.components/**

3.api/5.commands/**

3.api/**

4.exemples/**

5.community/**

6.bridge/**

7.migration/**

(each item could be a PR)
which will make a good number of pr!

Hmm, it might be good, but that would mean I'll have to open multiple PR's, wouldn't it? I dont want to be a bother and spam too much. And would I be able to open a PR and just drag and drop the files I have in this branch to each PR accordingly?

I think it's not spam because PR are meaning full.

And yes, you can easily create a PR with drag and drop. (https://docs.github.com/en/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)

danielroe · 2024-04-19T08:59:13Z

See my comment in #21040 (comment). I hate to close this as it has so many good changes, but it will be too tricky to merge + review. 😢

GalacticHypernova changed the title ~~docs: Grammatical improvements for the auto-imports guide page~~ docs: Grammatical improvements for the multiple guide pages May 2, 2023

GalacticHypernova changed the title ~~docs: Grammatical improvements for the multiple guide pages~~ docs: Grammatical improvements for multiple guide pages May 2, 2023

danielroe added documentation 3.x labels May 3, 2023

GalacticHypernova changed the title ~~docs: Grammatical improvements for multiple guide pages~~ docs: Grammatical improvements for nuxt.com May 3, 2023

GalacticHypernova marked this pull request as draft May 3, 2023 15:04

GalacticHypernova added 7 commits May 4, 2023 20:09

Grammar community/roadmap

0da9e9a

Better wording, typo fix community/roadmap

a78f17c

Grammar migration/overview

27f1f7e

Grammar migration/config

e8e1718

Grammar for migration/auto-imports

2e776d9

Grammar for migration/meta

1eea806

Grammar for migration/PAM

73fb22f

GalacticHypernova changed the title ~~docs: Grammatical improvements for nuxt.com~~ docs: Grammar overhaul May 4, 2023

GalacticHypernova added 14 commits May 4, 2023 21:00

Grammar migration/PAL

f25bff9

Keeping time migration/PAL

27b7bb5

Grammar migration/CO

ca58405

Grammar migration/RC

d249593

Grammar for migration/bundling, rename for convenience

58837d9

Renamed, added grammar to migration/server

6ce6a4e

Better wording migration/server

a7ea126

Renamed, grammar for migration/MA

7c2e38b

Grammar for examples/app/config

4dcc63f

Grammar examples/app/error

476a16d

Grammar examples/app/teleport

b9d2793

Grammar examples/auto/compos

3b9814a

Grammar examples/compos/use-async

3a7133d

Grammar examples/compos/use-cookie

f425d6e

GalacticHypernova added 6 commits May 12, 2023 18:44

Add autoImport to configuration documentation

f352246

Update adhoc.ts

1bda655

Update adhoc.ts

8a7d48b

Update adhoc.ts

1e50bd6

Update adhoc.ts

6e16c3a

Added back, looks like preview is the problem

f76639f

danielroe reviewed May 12, 2023

View reviewed changes

Syncing

c4aae8b

DamianGlowala requested changes May 12, 2023

View reviewed changes

GalacticHypernova and others added 5 commits May 12, 2023 23:37

Apply suggestions from code review

3f35a72

Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>

Update 3.modules.md

81a7684

Update 3.modules.md

b6c8fad

Update 3.modules.md

01831a8

Update 1.internals.md

ee49909

GalacticHypernova and others added 3 commits May 13, 2023 08:27

Merge branch 'main' into patch-3

4a5138e

Update docs/2.guide/2.directory-structure/1.pages.md

7035304

Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>

Update docs/2.guide/3.going-further/3.modules.md

00b9eea

Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com>

GalacticHypernova mentioned this pull request May 24, 2023

docs: Grammar overhaul getting started #21040

Closed

8 tasks

GalacticHypernova mentioned this pull request Jun 7, 2023

docs: JSDoc overhaul #21442

Draft

8 tasks

danielroe force-pushed the main branch from f78140e to 4168157 Compare January 9, 2024 09:39

danielroe closed this Apr 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Grammar overhaul #20636

docs: Grammar overhaul #20636

GalacticHypernova commented May 2, 2023 •

edited

codesandbox bot commented May 2, 2023

nuxt-studio bot commented May 2, 2023 •

edited

GalacticHypernova commented May 12, 2023

GalacticHypernova commented May 12, 2023

danielroe May 12, 2023

GalacticHypernova May 12, 2023 •

edited

DamianGlowala left a comment

DamianGlowala May 12, 2023

GalacticHypernova May 13, 2023 •

edited

DamianGlowala May 12, 2023

danielroe commented May 13, 2023

DamianGlowala commented May 13, 2023

GalacticHypernova commented May 13, 2023

Barbapapazes commented May 13, 2023 •

edited

GalacticHypernova commented May 13, 2023 •

edited

Barbapapazes commented May 15, 2023 •

edited

danielroe commented Apr 19, 2024

	We use `submit.post.ts` in the filename only to match requests with the `POST` method that can accept the request body. When using `readBody` within a GET request, `readBody` will throw a `405 Method Not Allowed` HTTP error.
	We use `submit.post.ts` filename to match requests only with the `POST` method (that can accept the request body). When using `readBody` within a GET request, `readBody` will throw the HTTP `405 Method Not Allowed` response status code.

	`useNuxtApp` (on the server) only works during `setup` inside Nuxt plugins or `Lifecycle Hooks`.
	`useNuxtApp` (on the server) works only during component's `setup` function, lifecycle hooks and inside Nuxt plugins.

docs: Grammar overhaul #20636

docs: Grammar overhaul #20636

Conversation

GalacticHypernova commented May 2, 2023 • edited

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

codesandbox bot commented May 2, 2023

nuxt-studio bot commented May 2, 2023 • edited

✅ Live Preview ready!

GalacticHypernova commented May 12, 2023

GalacticHypernova commented May 12, 2023

danielroe May 12, 2023

Choose a reason for hiding this comment

GalacticHypernova May 12, 2023 • edited

Choose a reason for hiding this comment

DamianGlowala left a comment

Choose a reason for hiding this comment

DamianGlowala May 12, 2023

Choose a reason for hiding this comment

GalacticHypernova May 13, 2023 • edited

Choose a reason for hiding this comment

DamianGlowala May 12, 2023

Choose a reason for hiding this comment

danielroe commented May 13, 2023

DamianGlowala commented May 13, 2023

GalacticHypernova commented May 13, 2023

Barbapapazes commented May 13, 2023 • edited

GalacticHypernova commented May 13, 2023 • edited

Barbapapazes commented May 15, 2023 • edited

danielroe commented Apr 19, 2024

GalacticHypernova commented May 2, 2023 •

edited

nuxt-studio bot commented May 2, 2023 •

edited

GalacticHypernova May 12, 2023 •

edited

GalacticHypernova May 13, 2023 •

edited

Barbapapazes commented May 13, 2023 •

edited

GalacticHypernova commented May 13, 2023 •

edited

Barbapapazes commented May 15, 2023 •

edited