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 structure update #14700

Closed
pi0 opened this issue Aug 24, 2022 · 4 comments
Closed

Docs structure update #14700

pi0 opened this issue Aug 24, 2022 · 4 comments
Assignees

Comments

@pi0
Copy link
Member

pi0 commented Aug 24, 2022

(Collabrated with @Atinux @danielroe @clemcode to set new structure)

Notes:

  • Items in (...) indicate old name.
  • I've removed [new] sections to make it a fast structure refactor

  • Landing
  • Getting Started
    • Intro (Concepts/What is Nuxt)
    • Installation (Getting Started>Quick Start)
    • Views (Features>Views)
    • Assets & Styles (features> assets)
    • SEO & Meta (Features>Head)
    • Data Fetching (Features>Data Fetching)
    • State Management (Features State Management)
    • Error Handling (Features>Error Handling)
    • Testing (Features/Testing)
    • Deployment (Deploy/* merged)
    • Upgrade guide
      • Upgrade from Nuxt 2 (Getting Started>Migration Guide)
      • Edge Channel
  • Guide
    • Key Concepts
      • Core Architecture (Advanced > How Nuxt Works + Life Cycle Hooks)
      • Auto Imports (Concepts > Auto Imports)
      • Development in Nuxt (Concepts/Vue.js Development)
      • Modules (Features/Modules)
      • Rendering Modes (Concepts > Rendering Modes)
      • ES Modules (Advanced > ES Modules)
      • Server (Features/Server Routes)
    • Directory structure
      • [auto-loaded files and dirs]
    • Module Guide
      • Get started (module author guide)
      • Nuxt Kit
  • API Reference
    • Composables
    • Components
    • Utils
    • Advanced
      • Lifecycle Hooks
      • Kit utils
    • Commands
    • Configuration
  • Examples
    • [categories]
  • Community
    • Getting help
    • Reporting bugs
    • Contribution
    • Roadmap
Copy link
Contributor

clemcode commented Aug 24, 2022

After a quick lookup, we missed a few pages. Here is a proposal for those in the new structure (left is their current place, right is the new structure or suggestions)
/concepts/server-engine (Merge with Key-concepts > Server)
/concepts/typescript (Split between pages - To be discussed)
/features/app-config (API reference > Configuration)
/features/runtime-config (API reference > Configuration)
/features/teleports (API Reference > Components)
/going-further/nuxt-app (API reference > Configuration)

@pi0
Copy link
Member Author

pi0 commented Aug 24, 2022

/features/app-config (API reference > Configuration)
/features/runtime-config (API reference > Configuration)
/features/teleports (API Reference > Components)
/going-further/nuxt-app (API reference > Configuration)

There are not API references. Please keep them somewhere within Guide in Key Concepts or Going Furthor. We need to discuss more for placement and content refactors.

@AndreyYolkin
Copy link
Contributor

Idk should I create separate issue for that, but link inside https://v3.nuxtjs.org/community/framework-contribution/ page is broken.
image
We need to replace it with https://v3.nuxtjs.org/community/contribution/

If needed I can create issue and PR for this, but might be it will be solved after resolving this issue

@pi0
Copy link
Member Author

pi0 commented Aug 29, 2022

Thanks for notice @AndreyYolkin. Feel free to directly open PR for quick docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants