docs: add Astro Starlight documentation site

[AVGVSTVS96]

Create a comprehensive documentation site for react-shiki using Astro
Starlight. This converts the README content into organized, navigable
documentation with better structure and searchability.

Documentation structure:

• Getting Started: Introduction, Installation, Quick Start
• Guides: Bundle Options, Themes, Languages, Line Numbers, Transformers,
  react-markdown Integration, Performance
• Reference: Component Props, Hook Options, RegExp Engines

Features:

• Full-text search via Pagefind
• Dark/light mode support
• Edit on GitHub links
• Responsive sidebar navigation
• Custom styling matching the project branding

[changeset-bot]

⚠️ No Changeset found

Latest commit: dce22ad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
react-shiki-docs	Ready	Preview, Comment	Dec 19, 2025 10:55am

1 Skipped Deployment

Project	Deployment	Review	Updated (UTC)
react-shiki	Skipped		Dec 19, 2025 10:55am

[claude]

Claude finished @AVGVSTVS96's task —— View job

---

Code Review Analysis

Analyzing this documentation PR to provide feedback on code quality, architecture, and best practices.

Todo List

• Review documentation structure and organization
• Analyze Astro configuration and setup
• Check if changeset is needed for this PR
• Review content quality and completeness
• Assess performance and security considerations
• Provide comprehensive feedback

Review Summary

This is a documentation-only PR that creates a comprehensive Astro Starlight documentation site. No changeset is needed since this doesn't modify the package source code - it only adds documentation infrastructure.

✅ Excellent Architecture & Organization

Documentation Structure:

• Well-organized 3-tier hierarchy: Getting Started → Guides → Reference
• Logical content progression from introduction to advanced topics
• Clear separation of concerns between basic usage and detailed reference

Technical Implementation:

• Clean Astro Starlight setup with proper configuration in docs/astro.config.mjs:4-55
• Proper workspace integration in pnpm-workspace.yaml:4
• Appropriate scripts added to root package.json:12-14

✅ Code Quality & Best Practices

Configuration Quality:

• Proper site URL configuration: docs/astro.config.mjs:5
• Correct GitHub social links and edit links: docs/astro.config.mjs:11,18
• Clean custom CSS with CSS custom properties: docs/src/styles/custom.css:3-37
• Professional logo integration with fallback text: docs/astro.config.mjs:13-16

Content Quality:

• Comprehensive coverage matching README structure
• Accurate API documentation in docs/src/content/docs/reference/component-props.md
• Practical examples throughout
• Good use of Starlight components (Cards, CardGrid) in homepage

✅ Performance Considerations

Optimized Setup:

• Astro's static site generation for fast loading
• Pagefind integration for client-side search
• Proper asset optimization with Sharp dependency
• No unnecessary dependencies or bloat

✅ Security & Best Practices

Secure Configuration:

• No hardcoded secrets or sensitive data
• Proper GitHub URLs with HTTPS
• Safe use of external links with appropriate icons
• No security vulnerabilities in dependencies

🔍 Minor Observations

1. Content Consistency: The documentation maintains excellent consistency with the main README while providing better organization and searchability.

2. Navigation UX: The sidebar structure provides intuitive navigation flow from basic concepts to advanced topics.

3. Responsive Design: Starlight provides excellent mobile responsiveness out of the box.

Changeset Assessment

✅ No changeset required - This PR:

• Only adds documentation infrastructure in /docs directory
• Doesn't modify package source code in /package directory
• Doesn't change API surface or functionality
• Is properly scoped as documentation-only changes

The changeset-bot's warning is expected and correct for this type of PR.

Final Verdict

This is a high-quality documentation PR that significantly improves the project's documentation experience. The implementation follows Astro/Starlight best practices, maintains excellent organization, and provides comprehensive coverage of the library's features.

Recommendation: ✅ Approve and merge

---