-
-
Notifications
You must be signed in to change notification settings - Fork 203
Docs/add guides section with getting started #623
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
base: main
Are you sure you want to change the base?
Docs/add guides section with getting started #623
Conversation
…entation structure
There was a problem hiding this 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@betato@pixi/react, but this appears to be updating documentation to reflect the stable release. However, the package.json shows the docs still use version8.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" |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this 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.
Description
This PR implements a new
Guidessection in the documentation website, complete with navbar integration and a comprehensive Getting Started guide for new users.Closes #589
Changes Made
Guidessection to documentation sidebar navigationAcceptance Criteria ✓
Guidessection of the documentation websiteGuidessection includes aGetting Startedguide walking users through creating their first app with Pixi ReactScreenshot