Fix website RemoteSource URL bug #1595
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
commit: |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation site by improving error handling in the RemoteSource loader, reorganizing example file paths with updated references, refining formatting across multiple MDX files, and introducing a new AssertionGuard type for runtime type assertions.
- Enhanced fetch error handling in the
RemoteSourcecomponent - Restructured example directory paths and updated all corresponding MDX references
- Added detailed
AssertionGuardtype definition and related docs
Reviewed Changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/components/RemoteSource.tsx | Log and surface fetch errors when loading remote examples |
| website/pages/index.mdx | Fixed blank lines and updated example comment from checkUUID.js |
| website/pages/docs/validators/functional.mdx | Replaced inline TypeGuardError code block with RemoteSource |
| website/pages/docs/setup.mdx | Imported RemoteSource and replaced inline code with RemoteSource |
| website/pages/docs/random.mdx | Updated example URLs to new random/ subfolder structure |
| website/pages/docs/llm/strategy.mdx | Corrected typo in example file name from hideden to hidden |
| website/pages/docs/index.mdx | Cleaned blank lines and aligned example comment text |
| src/AssertionGuard.ts | Added AssertionGuard<T> type definition with full docs |
| examples/src/random/random-tag.ts | Removed stray trailing whitespace |
| examples/src/random/random-comment-tag.ts | Added new comment-based random-tag example |
| README.md | Updated example comment from checkUUID.js to checkString.js |
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 several updates across documentation, examples, and source code to enhance functionality, improve clarity, and fix inconsistencies. The key changes include the addition of a new
AssertionGuardtype definition, restructuring of example file paths, and updates to documentation for better formatting and accuracy.New Features and Enhancements:
typia, explaining their purpose, usage, and behavior. This includes examples and references to related documentation. (src/AssertionGuard.ts)File Organization and Examples:
examples/src/random/random-tag.tsinstead ofexamples/src/random-tag.ts). This affects multiple files and references in the documentation. [1] [2] [3] [4]Documentation Updates:
website/pages/docs/index.mdx,website/pages/docs/setup.mdx) [1] [2] [3]RemoteSourcecomponents for better maintainability and dynamic loading of example code in documentation. (website/pages/docs/setup.mdx,website/pages/docs/validators/functional.mdx) [1] [2]Bug Fixes:
application-hideden.tstoapplication-hidden.ts. (website/pages/docs/llm/strategy.mdx)Codebase Maintenance:
RemoteSourcecomponent to log errors when fetching files fails, improving debugging and reliability. (website/src/components/RemoteSource.tsx)