Skip to content

docs: improve manifest.json documentation clarity and completeness#20524

Merged
sapphi-red merged 5 commits intomainfrom
copilot/fix-b2cadb5d-8149-471c-840c-3a33371ac649
Aug 5, 2025
Merged

docs: improve manifest.json documentation clarity and completeness#20524
sapphi-red merged 5 commits intomainfrom
copilot/fix-b2cadb5d-8149-471c-840c-3a33371ac649

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jul 31, 2025

Improves the manifest.json documentation in the Backend Integration guide based on feedback from issue #16525. The previous documentation was confusing regarding different chunk types, processing order, and CSS import behavior.

Key Improvements

Section 3 - Manifest Structure

  • Added inline TypeScript interface: Included direct ManifestChunk interface definition instead of GitHub link to prevent stale links
  • Added asset chunk example: Included logo.svg example to clarify asset chunks that don't have _ prefix
  • Clearer chunk categorization: Organized chunk types into distinct categories with specific characteristics:
    • Entry chunks (with isEntry: true)
    • Dynamic entry chunks (with isDynamicEntry: true)
    • Non-entry chunks (with _ prefix)
    • Asset chunks (imported assets like images/fonts)
    • CSS files (when cssCodeSplit is false or true)
  • Enhanced CSS file documentation: Added clarification about CSS file naming behavior when cssCodeSplit is not false

Section 4 - Processing Order and CSS Behavior

  • Changed to numbered list: Indicates that order matters for optimal performance (though not strictly required)
  • Simplified CSS property guidance: Streamlined explanation of CSS list processing
  • Focused entry point types: Simplified description to emphasize JavaScript and CSS tags

Additional Context

The changes address specific questions raised in the issue:

  • Order does matter for performance optimization
  • CSS entry points don't have css properties
  • No cycles should exist in chunk imports
  • Entry points can be any file type

All improvements maintain backward compatibility and preserve existing examples while adding crucial clarifications that were missing.

Fixes #16525


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve the document based on @vitejs/vite/issues/16525 docs: improve manifest.json documentation clarity and completeness Jul 31, 2025
Copilot AI requested a review from sapphi-red July 31, 2025 18:05
- Replace GitHub link with inline TypeScript interface definition to prevent stale links
- Simplify non-entry chunks description
- Remove unnecessary bold formatting
- Clarify CSS property checking in processing instructions
- Simplify entry point tag description
- Update asset chunks description per feedback
- Add CSS file naming behavior when cssCodeSplit is not false

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>
Copilot AI requested a review from sapphi-red August 1, 2025 07:01
Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>
Copilot AI requested a review from sapphi-red August 1, 2025 07:28
@sapphi-red sapphi-red added the documentation Improvements or additions to documentation label Aug 1, 2025
@sapphi-red sapphi-red marked this pull request as ready for review August 1, 2025 07:49
Copy link
Copy Markdown
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

Nice! This looks a ton better

@sapphi-red sapphi-red merged commit bd1e019 into main Aug 5, 2025
15 checks passed
@sapphi-red sapphi-red deleted the copilot/fix-b2cadb5d-8149-471c-840c-3a33371ac649 branch August 5, 2025 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Manifest.json Documentation is Confusing

3 participants