fix/ci pr 55#56
Merged
Merged
Conversation
The docgen was failing because examples in TSchema.ts were importing TSchema directly from the package root, but after moving everything to the Core namespace, it's now available as Core.TSchema. Fixed all @example blocks to use: import { Core } from "@evolution-sdk/evolution" Core.TSchema.Struct(...) This fixes the CI failure in the docs build step.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR contains documentation and comment updates across the codebase, including example code improvements, navigation order adjustments, and consistency fixes.
- Removed verbose documentation comments from schema transformation functions in Assets.ts
- Updated import examples in TSchema.ts to use the more specific
Corenamespace instead ofTSchema - Fixed Next.js types import path in docs/next-env.d.ts
Reviewed Changes
Copilot reviewed 256 out of 257 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/evolution/src/sdk/Assets.ts | Removed redundant inline documentation from ValueFromAssets and MintFromAssets schemas |
| packages/evolution/src/core/TSchema.ts | Updated example imports from TSchema to Core.TSchema for better namespace clarity |
| docs/next-env.d.ts | Updated Next.js types import path from ./out/dev/types/routes.d.ts to ./.next/types/routes.d.ts |
| packages/evolution/docs/modules/**/*.md | Updated nav_order values and renamed types/classes for consistency (e.g., AddressStructure → Address, AddressError → AddressErasError) |
| docs/content/docs/modules/**/*.mdx | Applied same documentation updates as .md files for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.