Refactor documentation structure and remove unused components #121
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 import paths for ReactQueryProvider and other components to ensure consistency. - Deleted unused files and components, including various example pages and utility functions, to streamline the codebase. - Adjusted TypeScript configuration for improved module resolution. - Enhanced overall organization of the documentation structure for better clarity and maintainability.
commit: |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors the documentation structure by introducing dynamic metadata generation, adjusting component imports, and removing unused components to streamline the codebase.
- Added dynamic metadata generation in the MDX page renderer with interactive Playground integration.
- Updated component import paths to use the "@docs-components" alias and corrected the repository URL formatting.
- Introduced new metadata files (_meta.tsx) to better structure documentation and examples.
Reviewed Changes
Copilot reviewed 81 out of 81 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs/content/docs/_meta.tsx | Created a meta record for core documentation topics. |
| packages/docs/content/_meta.tsx | Defined an examples list in the metadata structure for example pages. |
| packages/docs/client-mdx-components.js | Updated ReactQueryProvider import to use the "@docs-components" alias. |
| packages/docs/app/layout.tsx | Removed trailing slash from docsRepositoryBase URL. |
| packages/docs/app/[[...mdxPath]]/page.tsx | Implemented dynamic metadata generation and interactive Playground. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
This pull request introduces significant enhancements to the PlayCanvas documentation system, including support for dynamic metadata generation, improved component imports, and a new metadata structure for organizing examples and documentation. Below are the most important changes grouped by theme:
Dynamic Metadata and Page Rendering:
[[...mdxPath]]/page.tsx, enabling metadata to be fetched and parsed for example pages using.meta.jsonfiles. This also includes rendering examples with thePlaygroundcomponent for interactive code previews. (packages/docs/app/[[...mdxPath]]/page.tsxR1-R63)Component Import Adjustments:
layout.tsxandclient-mdx-components.jsto use the@docs-componentsalias instead of relative paths, improving consistency and maintainability. [1] [2]Metadata Structure for Examples and Documentation:
_meta.tsxfile for organizing example pages with titles, links, and categories, providing a structured way to manage examples in the documentation._meta.tsxfile for thedocssection to define metadata for core documentation topics such as installation, guide, and API.Repository Link Update:
docsRepositoryBaseURL inlayout.tsxto remove the trailing slash, ensuring proper linking to the GitHub repository.