Skip to content

Fix links and grammar in docs #199

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 2 commits into from
Jul 13, 2025
Merged

Fix links and grammar in docs #199

merged 2 commits into from
Jul 13, 2025

Conversation

willeastcott
Copy link
Contributor

Attempted to fix all the broken links and grammatical errors that I could find in the docs.

@willeastcott willeastcott self-assigned this Jul 12, 2025
@willeastcott willeastcott added bug Something isn't working documentation Improvements or additions to documentation labels Jul 12, 2025
Copy link

changeset-bot bot commented Jul 12, 2025

⚠️ No Changeset found

Latest commit: 6655b7b

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

Copy link

pkg-pr-new bot commented Jul 12, 2025

Open in StackBlitz

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

commit: 6655b7b

Copy link
Contributor

@Copilot 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 fixes broken documentation links and corrects various grammatical issues across the docs.

  • Updated internal and external links to match the current API paths
  • Standardized capitalization and spelling (e.g., PlayCanvas, Vite, its/it's, behavior)
  • Cleaned up headings, removed stray punctuation, and trimmed extraneous lines

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/lib/.playcanvas-react.mdc Fixed comment grammar: ‘behaviours’ → ‘behaviors’
packages/docs/content/faq.mdx Changed “FAQ’s” → “FAQ” and improved comma placement
packages/docs/content/docs/index.mdx Capitalized “PlayCanvas”
packages/docs/content/docs/guide/loading-assets.mdx Updated asset hooks reference links
packages/docs/content/docs/guide/getting-started.mdx Capitalized “Vite,” corrected “On it’s own” → “On its own”
packages/docs/content/docs/api/index.mdx Adjusted core component link paths
packages/docs/content/docs/api/hooks/use-material.mdx Pointed to updated StandardMaterial URLs
packages/docs/content/docs/api/hooks/use-asset.mdx Fixed asset hook documentation links
packages/docs/content/docs/api/hooks/index.mdx Updated Application API link
packages/docs/content/docs/api/entity.mdx Standardized “behavior” spelling, updated Entity API link
packages/docs/content/docs/api/components/scripts.mdx Standardized “behavior” spelling, updated Script link
packages/docs/content/docs/api/components/rigidbody.mdx Standardized “behaviors” spelling
packages/docs/content/docs/api/components/envatlas.mdx Adjusted props source link (see suggestion)
packages/docs/content/docs/api/components/collision.mdx Updated Collision Component links and API references
packages/docs/content/docs/api/components/camera.mdx Updated Camera Component API link
packages/docs/content/docs/api/components/anim.mdx Updated Asset class documentation link
packages/docs/content/docs/api/components/align.mdx Corrected possessive grammar (“its” parent)
packages/blocks/src/splat-viewer/hooks/use-render-on-camera-change.tsx Corrected “it’s projection” → “its projection”
Comments suppressed due to low confidence (2)

packages/lib/.playcanvas-react.mdc:21

  • The import 'RigigBody' appears to be misspelled; it should likely be 'RigidBody' to match the component name exported from '@playcanvas/react/components'.
import { Light, Camera, Render, Gsplat, Screen, Collision, RigigBody, Anim } from '@playcanvas/react/components'

packages/docs/content/docs/api/components/envatlas.mdx:50

The following props are based on the [Scene API](https://api.playcanvas.com/engine/classes/Scene.html) from PlayCanvas version **<PcVersion />**. This documentation is automatically generated from the TypeScript types of the installed PlayCanvas package.

@marklundin marklundin merged commit f9c923f into main Jul 13, 2025
5 checks passed
@marklundin marklundin deleted the docs-fixes branch July 13, 2025 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants