Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.
/frameworkPublic archive

docs: add nuxt layers introduction and authoring guide - #9405

Merged
pi0 merged 33 commits into
nuxt:mainfrom
cpreston321:feat/extendsDocs
Dec 5, 2022
Merged

docs: add nuxt layers introduction and authoring guide #9405
pi0 merged 33 commits into
nuxt:mainfrom
cpreston321:feat/extendsDocs

Conversation

@cpreston321

@cpreston321cpreston321 commented Nov 29, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

❓ 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

This adds more detail about the how to use extends since it's very powerful with little documentation we have now on this feature. I wanted to help out but hopefully this is a start to show off how nice of a feature this is. If you need modify it or change the structure on where it's located please let me know!

Thanks 💚

📝 Checklist

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

@codesandbox

codesandboxBot commented Nov 29, 2022

Copy link
Copy Markdown

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

@cpreston321cpreston321 changed the title feat(docs): Extend Theme Configdocs(extend-configs): added new section for extends featureNov 29, 2022
@cpreston321cpreston321 changed the title docs(extend-configs): added new section for extends featuredocs(extend-theme): added new section for extends featureNov 29, 2022
TheAlexLichter
TheAlexLichter suggested changes Nov 29, 2022
View reviewed changes

@TheAlexLichterTheAlexLichter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good start! Left some remarks

Comment threaddocs/content/1.docs/1.getting-started/3.extends-theme.md Outdated
Comment threaddocs/content/1.docs/1.getting-started/3.extends-theme.md Outdated
Comment threaddocs/content/1.docs/1.getting-started/3.extends-theme.md Outdated
Comment threaddocs/content/1.docs/1.getting-started/3.extends-theme.md Outdated
Comment threaddocs/content/1.docs/1.getting-started/3.extends-theme.md Outdated
@cpreston321

cpreston321 commented Nov 29, 2022

Copy link
Copy Markdown
ContributorAuthor

@manniL Updated ✅

@pi0
pi0 self-requested a review December 2, 2022 09:41
@pi0

pi0 commented Dec 2, 2022

Copy link
Copy Markdown
Member

Thanks for the PR @cpreston321 ❤️

I like to move it to Guide > Going Further > Nuxt Layers to be consistent with the starter name (nuxt/starter#183) and generally the way we announce this feature.

What do you think @antfu@danielroe@atinux?

@TheAlexLichter

TheAlexLichter commented Dec 2, 2022

Copy link
Copy Markdown
Member

I like to move it to Guide > Going Further > Nuxt Layers to be consistent with the starter name (nuxt/starter#183) and generally the way we announce this feature.

We call all things we can extends layers then, right? (Just want to nail the terminology)

@pi0pi0 self-assigned this Dec 2, 2022
@pi0

pi0 commented Dec 2, 2022•
edited
Loading

Copy link
Copy Markdown
Member

(working on some refactors to try splitting into user guide + author guide)

We call all things we can extend layers then, right? (Just want to nail the terminology)

Yes, that's almost the idea having a consistent naming for the feature :)

@danielroe
danielroe requested review from clemcode and removed request for clemcodeDecember 2, 2022 10:54
danielroe
danielroe approved these changes Dec 2, 2022
View reviewed changes

@danielroedanielroe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is a great initiative - many thanks indeed! ❤️

pi0
pi0 reviewed Dec 2, 2022
View reviewed changes
Comment threaddocs/content/1.docs/2.guide/3.going-further/7.layers.md Outdated
@pi0
pi0 requested a review from atinuxDecember 2, 2022 14:09
@cpreston321

cpreston321 commented Dec 2, 2022

Copy link
Copy Markdown
ContributorAuthor

Glad to see that everyone is helping - this feature is so powerful.

I appreciate you all 💚

@cpreston321

cpreston321 commented Dec 3, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

related issue when adding nitro layers to extend repo as a node module: nuxt/nuxt#15768

@TheAlexLichter

TheAlexLichter commented Dec 3, 2022

Copy link
Copy Markdown
Member

Also important to consider: https://github.com/nuxt/framework/discussions/9418

atinux
atinux reviewed Dec 4, 2022
View reviewed changes
Comment threaddocs/content/1.docs/2.guide/3.going-further/7.layers.md
@pi0pi0 mentioned this pull request Jan 19, 2023
Closed
18 tasks
@pi0pi0 changed the title docs(extend-theme): added new section for extends featuredocs: add nuxt layers introduction and authoring guide Dec 5, 2022
@pi0
pi0 merged commit 77e2974 into nuxt:mainDec 5, 2022
@pi0

pi0 commented Dec 5, 2022

Copy link
Copy Markdown
Member

Thanks all for helping on this 🙌 Let's iterate to improve layers support and docs.

@atinux

atinux commented Dec 5, 2022

Copy link
Copy Markdown
Member

Was going to push, could have wait for my approval that was coming in few minutes, anyway will push my changes directly to main 👍

@pi0pi0 mentioned this pull request Dec 15, 2022
Closed
6 tasks
@cpreston321
cpreston321 deleted the feat/extendsDocs branch December 16, 2022 18:43
@danielroedanielroe mentioned this pull request Jan 20, 2023
Merged
danielroe added a commit that referenced this pull request Jan 21, 2023
@cpreston321@TheAlexLichter
Sébastien Chopin@pi0@danielroe
docs: add nuxt layers introduction and authoring guide (#9405)
380ba74
Co-authored-by: Alexander Lichter <github@lichter.io>
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
Co-authored-by: Pooya Parsa <pooya@pi0.io>
Co-authored-by: Daniel Roe <daniel@roe.dev>
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@clemcodeclemcodeAwaiting requested review from clemcode
5 more reviewers
@TheAlexLichterTheAlexLichterTheAlexLichter approved these changes
@atinuxatinuxatinux left review comments
@TahulTahulTahul left review comments
@pi0pi0pi0 approved these changes
@danielroedanielroedanielroe approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@pi0pi0

Labels

3.x

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@cpreston321@pi0@TheAlexLichter@atinux@Tahul@danielroe