Skip to content

docs: remove duplicate part in 4.assets.md #30002

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 27, 2024
Merged

docs: remove duplicate part in 4.assets.md #30002

merged 1 commit into from
Nov 27, 2024

Conversation

mianlang
Copy link
Contributor

@mianlang mianlang commented Nov 21, 2024 •
edited
Loading

🔗 Linked issue

Searched and not found.

📚 Description

Remove the Global Styles Imports part, since it is already documented in the last part of 5.styling Using Preprocessors.
They have similar expression and identical code snippets. Moving it to Styling makes more sense.

Summary by CodeRabbit

  • Documentation
    • Restructured asset management documentation for improved clarity.
    • Clarified the roles of public/ and assets/ directories in Nuxt.
    • Expanded information on build tools (Vite and webpack) for asset processing.
    • Removed the section on "Global Styles Imports," indicating changes in global style handling.

@mianlang
Update 4.assets.md
ab41857 
Remove the Global Styles Imports part, since it is already documented in Using Preprocessors section under 5.styling with similar expression. Moving it to Styling makes more sense.
@mianlang mianlang requested a review from danielroe as a code owner November 21, 2024 03:06
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 21, 2024 •
edited
Loading

Walkthrough

The documentation for asset management in Nuxt has been revised to improve clarity and structure. Key changes include a clearer explanation of the public/ and assets/ directories, detailing their roles and how they are accessed. The section on global styles imports has been removed, indicating a shift in how these styles are documented or managed. Overall, the focus is on enhancing the understanding of asset handling within Nuxt.

Changes

File Path Change Summary
docs/1.getting-started/4.assets.md - Restructured content on asset management.
- Clarified roles of public/ and assets/ directories.
- Expanded explanation on build tools (Vite and webpack) for processing assets.
- Removed section on "Global Styles Imports," including SCSS and SASS examples.

Suggested labels

documentation, 3.x

Suggested reviewers

  • danielroe

Poem

🐇 In the garden of assets, we tidy and clear,
With public/ and assets/, the path is now near.
Global styles took flight, no longer in sight,
Clarity blooms, making everything bright!
Hopping through changes, we celebrate cheer,
In Nuxt's lovely world, we hold treasures dear! 🌼

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between edc299a and ab41857.

📒 Files selected for processing (1)
  • docs/1.getting-started/4.assets.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/1.getting-started/4.assets.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mianlang
Copy link
Contributor Author

mianlang commented Nov 21, 2024 •
edited
Loading

Or maybe we should add something to the Assets Example part, linking to 5.styling Using Preprocessors?
It looks to me there is no need. The Global Styles Imports has more to do with preprocessor option rather than where the style file locates.

@danielroe danielroe merged commit ed7ca0a into nuxt:main Nov 27, 2024
11 of 12 checks passed
@github-actions github-actions bot mentioned this pull request Nov 27, 2024
Merged
danielroe pushed a commit that referenced this pull request Nov 27, 2024
@mianlang @danielroe
docs: remove duplicate information about preprocessor variables (#30002)
6998719
@github-actions github-actions bot mentioned this pull request Nov 27, 2024
Merged
This was referenced Nov 28, 2024
Merged
Merged
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@mianlang @Kamsou
docs: remove duplicate information about preprocessor variables (nuxt…
a31304a 
…#30002)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mianlang @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy