Adds installable LLM rules.mdc
#139
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated README.md to include a new section on AI Assisted Development, providing installation instructions for MDC rules. - Revised blocks.mdx to clarify the description of 3D building blocks and their usage. - Improved the SplatViewer documentation with additional details on features and usage examples. - Added new MDC files for blocks and SplatViewer to standardize component usage rules. - Enhanced the index.mdx to better explain the purpose of the PlayCanvas React library and its features. These changes improve the clarity and usability of the documentation, making it easier for developers to get started with PlayCanvas React.
…ty in documentation structure.
…es in README.md and index.mdx files.
…links by hiding icons on smaller screens.
marklundin
added
documentation
commit: |
- Replaced direct imports of Splat components with a unified import from the new Splat module. - Updated the `useMDXComponents` function to include Splat as a component. - Adjusted documentation in blocks.mdx to reflect the new import structure for Splat components.
Fixes build issue
There was a problem hiding this comment.
Pull Request Overview
This PR introduces installable MDC rules to improve LLM context for the library and its components. Key changes include the addition of new MDC rule files for @playcanvas/react, splat-viewer, and blocks; updates to documentation to guide IDE rule installation; and minor adjustments to component exports and examples.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/lib/README.md | Added Stackblitz template and AI Assisted Development instructions for installing MDC rules. |
| packages/lib/.playcanvas-react.mdc | Introduced MDC rules for @playcanvas/react including usage examples. |
| packages/docs/registry/splat-viewer/index.tsx | Renamed SplatViewer export to Viewer for consistency. |
| packages/docs/registry/splat-viewer/.splat-viewer.mdc | Added MDC rules for splat-viewer along with usage examples. |
| packages/docs/registry/.blocks.mdc | Added MDC rules for 3D blocks with guidance on component usage. |
| packages/docs/registry-mdx-components.tsx & packages/docs/mdx-components.js | Removed/deprecated registry MDX components and updated MDX components accordingly. |
| packages/docs/content/docs/index.mdx | Updated examples and documentation layout with revised installation and component usage instructions. |
| packages/docs/content/blocks.mdx | Updated content and command instructions to reference splat-viewer MDC rules. |
| packages/docs/app/rules/route.tsx | Added a new API route to serve the MDC rules. |
| README.md | Updated top-level documentation with AI Assisted Development instructions. |
Comments suppressed due to low confidence (1)
packages/docs/content/docs/index.mdx:89
- The code snippet uses the Render component without importing it; add an import for Render from '@playcanvas/react/components' to ensure the example is self-contained and functional.
<Render type='cube' />
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of today, the project hasn't been fully indexed by LLM's and vibe coding often produces confused results. Whilst wait for better coverage, this PR adds a set of
rules.mdcfiles that can provide LLM's with better context of the library and how it works.There are a couple of rules
<SplatViewer/>The @playcanvas/react rules are available on https://playcanvas-react.vercel.app/rules (when deployed)
Docs
The docs & README have been updated with some information on installing and LLM rules with instructions for both Cursor and Windsurf.
Splat Viewer rules
Rules have been added to the registry so running
npx shadcn add splat-viewerautomatically installs the rules to the IDE.There are also a few docs layout improvements.