chore(changeset): experimental release 1#24
Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a comprehensive documentation system with executable examples and modernizes the build tooling. It sets up an experimental release flow with automated documentation generation and removes the previously separate verify command.
- Implements executable TypeScript examples with snippet injection into MDX documentation
- Converts documentation build system from CommonJS to ESM with modern Nextra configuration
- Adds automated testing and generation pipeline for documentation examples
Reviewed Changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Removes unused docs:verify script |
| docs/test/examples.test.ts | Deletes comprehensive test suite for documentation examples |
| docs/scripts/run-examples-and-generate.sh | Adds bash script for running examples and generating docs |
| docs/scripts/generate-getting-started.ts | Implements snippet injection system for MDX documentation |
| docs/scripts/copy-evolution-docs.ts | Converts script from .mjs to .ts format |
| docs/scripts/copy-evolution-docs.mjs | Removes old CommonJS script |
| docs/pages/getting-started/data/*.mdx | Generated MDX files with code examples |
| docs/pages/getting-started/data.mdx | Removes old static documentation |
| docs/pages/getting-started/address.mdx | Updates with snippet injection markers |
| docs/package.json | Modernizes with ESM support and new dependencies |
| docs/next.config.mjs | New ESM Next.js configuration |
| docs/next.config.js | Removes old CommonJS configuration |
| docs/examples/data/*.ts | Executable TypeScript examples with region markers |
| docs/examples/*.ts | Core examples for address and data modules |
| .changeset/experimental-release-1.md | Changeset for experimental release |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| echo "--------------------------------" | ||
|
|
||
| # Run the snippet generation script | ||
| if pnpm exec tsx "scripts/generate-getting-started.ts"; then |
There was a problem hiding this comment.
The script path is hardcoded as a string literal. Consider using a variable like $SCRIPTS_DIR/generate-getting-started.ts for consistency with how other paths are handled in this script.
| if pnpm exec tsx "scripts/generate-getting-started.ts"; then | |
| if pnpm exec tsx "$SCRIPTS_DIR/generate-getting-started.ts"; then |
| const __dirname = path.dirname(__filename) | ||
|
|
||
| // docs/ directory | ||
| const DOCS_ROOT = path.resolve(__dirname, "..") |
There was a problem hiding this comment.
[nitpick] The import from 'url' module is used but the script could use import.meta.dirname (available in Node.js 20.11+) instead of the fileURLToPath pattern for cleaner code.
| const DOCS_ROOT = path.resolve(__dirname, "..") | |
| // docs/ directory | |
| const DOCS_ROOT = path.resolve(import.meta.dirname, "..") |
No description provided.