Skip to content

Conversation

@creativoma
Copy link

Description

This PR implements a new Guides section in the documentation website, complete with navbar integration and a comprehensive Getting Started guide for new users.

Closes #589

Changes Made

  • ✅ Added Guides section to documentation sidebar navigation
  • ✅ Created Getting Started guide with ecosystem overview, introduction, and quick start tutorial
  • ✅ Migrated documentation structure from JSON to YAML format for better maintainability
  • ✅ Reorganized existing guides (Extend, TypeScript, Hooks) into dedicated folders
  • ✅ Enhanced sidebar functionality with new DocSidebarItemWrapper component
  • ✅ Various layout and styling improvements

Acceptance Criteria ✓

  • Users can easily find the Guides section of the documentation website
  • The Guides section includes a Getting Started guide walking users through creating their first app with Pixi React

Screenshot

image

@creativoma creativoma mentioned this pull request Aug 15, 2025
2 tasks
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a comprehensive Guides section to the documentation website with three new guides (Introduction, Quick Start, and Ecosystem) and integrates it into the navigation. The documentation configuration is migrated from JSON to YAML format for improved maintainability, and the sidebar navigation is enhanced with a custom wrapper component for better styling control.

  • New Getting Started guides providing onboarding for new users
  • Migration from JSON to YAML for category configuration files
  • Navbar dropdown integration for the Guides section

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/versioned_docs/version-7.x/about.mdx Fixes image path by removing redundant /pixi-react prefix
docs/src/theme/DocSidebarItem/index.tsx Adds custom sidebar item wrapper for enhanced styling control
docs/src/pages/index.tsx Adds bottom margin to homepage layout
docs/docusaurus.config.ts Adds Guides dropdown to navbar Docs section
docs/docs/typescript/typescript.mdx Adds frontmatter metadata (position and description)
docs/docs/hooks/category.yml Replaces JSON with YAML configuration
docs/docs/hooks/category.json Removes old JSON configuration
docs/docs/getting-started/quick-start.mdx Updates guide title and fixes import paths
docs/docs/getting-started/intro.mdx Adds comprehensive introduction guide with features and ecosystem overview
docs/docs/getting-started/ecosystem.mdx Adds ecosystem guide covering React integration, PixiJS features, and tooling
docs/docs/getting-started/category.yml Adds category configuration for Getting Started section
docs/docs/extend/extend.mdx Updates frontmatter metadata (position and description)
docs/docs/components/category.yml Replaces JSON with YAML configuration
docs/docs/components/category.json Removes old JSON configuration
Comments suppressed due to low confidence (1)

docs/docs/getting-started/quick-start.mdx:14

  • The installation command changed from @pixi/react@beta to @pixi/react, but this appears to be updating documentation to reflect the stable release. However, the package.json shows the docs still use version 8.0.0-beta.24. Consider verifying the correct version tag to recommend to users.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

</h1>
<img
src="/pixi-react/v7/img/pixi-react-logo.png"
src="/v7/img/pixi-react-logo.png"
Copy link
Collaborator

Choose a reason for hiding this comment

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

@trezy this still the logo to go with?

thejustinwalsh
thejustinwalsh previously approved these changes Nov 27, 2025
Copy link
Collaborator

@thejustinwalsh thejustinwalsh left a comment

Choose a reason for hiding this comment

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

Thank you!

I recomend removing CRA from the docs, otherwise LGTM.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Guide: Getting Started

2 participants