Skip to content

Seperates Blocks home pages #147

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

Merged
merged 3 commits into from
May 23, 2025
Merged

Seperates Blocks home pages #147

merged 3 commits into from
May 23, 2025

Conversation

marklundin
Copy link
Member

This pull request introduces several updates and improvements to the PlayCanvas Blocks project, focusing on documentation enhancements, new components, and minor adjustments to styles and functionality. Key changes include the addition of new documentation pages, updates to the vignette intensity in the style utilities, and the introduction of a new Block component.

Documentation Updates:

  • Added a new "Getting Started" guide in packages/docs/content/blocks/getting-started.mdx, detailing installation instructions for PlayCanvas Blocks and Tailwind v4.
  • Introduced a new "Blocks" documentation page (packages/docs/content/blocks/index.mdx), highlighting features, usage, and the "Splat Viewer" block.
  • Renamed and updated the splat-viewer documentation file (packages/docs/content/blocks/splat-viewer.mdx), separating it from the main "Blocks" index page.

Component Additions and Updates:

  • Added a new Block component in packages/docs/components/Check.tsx, designed to display features or blocks with an icon and description.
  • Updated the vignette intensity in packages/blocks/src/splat-viewer/utils/style.ts from 0.4 to 0.6 for improved visual effects.

Registry and Metadata Adjustments:

  • Updated the registry file (packages/docs/registry.json) to rename "3D Blocks" to "Blocks" and updated URLs for better alignment with the new documentation structure. [1] [2]
  • Changed the splatUrl in packages/docs/registry/splat-viewer.tsx to point to a new compressed 3D model URL.

Minor Changes:

  • Updated the title spacing in packages/docs/content/docs/index.mdx for improved visual alignment.
  • Updated the Tailwind installation link in packages/blocks/README.md to reference Tailwind v4.

- Increased vignette intensity in style.ts from 0.4 to 0.6 for enhanced visual effect.
- Renamed "3d-blocks" to "blocks" in registry.json for consistency.
- Updated homepage and docs links in registry.json to point to the correct paths.
- Added new Block component in Check.tsx for better UI representation.
- Created getting-started.mdx and index.mdx files for comprehensive documentation on Blocks.
- Introduced splat-viewer.mdx to detail the Splat Viewer component features and usage.
- Updated the SplatViewer component to use a new asset URL for improved performance.
- Updated README.md and getting-started.mdx to specify Tailwind v4 instead of the previous version, ensuring clarity for users on the required Tailwind version for installation.
@marklundin marklundin self-assigned this May 23, 2025
@marklundin marklundin added documentation Improvements or additions to documentation Blocks labels May 23, 2025
Copy link

pkg-pr-new bot commented May 23, 2025

Open in StackBlitz

npm i https://pkg.pr.new/playcanvas/react/@playcanvas/react@147

commit: 751ff1a

- Changed references from **globals.css** to **index.css** in getting-started.mdx to align with Tailwind configuration.
- Restored the OpenInV0Button in splat-viewer.mdx and added instructions for ensuring Tailwind processing in **index.css**.
@marklundin marklundin merged commit 3e3ad8f into main May 23, 2025
5 checks passed
@marklundin marklundin deleted the docs-blocks-rewrite branch May 23, 2025 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocks documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant