chore: standardize error documentation with Discord disclaimer #174
Conversation
…rd disclaimer Updated all 51 error documentation pages to have a unified format and added a prominent Discord disclaimer tip at the top of each page. This makes the documentation more consistent and encourages users to seek help from the community. Changes include: - Added config category (ZE40xxx) to error codes - Created 19 missing error documentation pages - Added Discord "Quick Help" tip to all 51 error pages - Removed duplicate "Ask for Support" sections - Standardized page structure across all error documentation This ensures users know the fastest way to get help is to join our Discord community. 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
|
🚀 Preview Environment Ready!
Details:
|
Replaced references to `npx zephyr login` and `npx zephyr logout` with instructions to authenticate via the dashboard or Chrome extension, as these CLI commands don't exist. 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
Updated ze40006.mdx to use the correct package names: - zephyr-webpack-plugin (not @anthropic-ai/zephyr-webpack-plugin) - vite-plugin-zephyr (not @anthropic-ai/zephyr-vite-plugin) - rollup-plugin-zephyr (not @anthropic-ai/zephyr-rspack-plugin) 🤖 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
Co-authored-by: Daiane Silva <[email protected]>
Nsttt
changed the title
There was a problem hiding this comment.
Pull request overview
This PR standardizes error documentation across the Zephyr codebase by adding a consistent "Quick Help" Discord disclaimer to all 51 error pages, creating 19 previously missing error documentation pages, and introducing a new error category (config/ZE40xxx) for configuration-related errors. The changes improve documentation completeness and provide users with a unified experience when encountering errors.
Key Changes:
- Added new config error category (ZE40xxx) with 6 error types for Module Federation and configuration issues
- Created 19 new error documentation pages covering build errors (ze10022-ze10036), deployment errors (ze20034-ze20037), and config errors (ze40001-ze40035)
- Standardized all error pages with "Quick Help" tip directing users to Discord support
- Removed duplicate "Ask for Support" sections from existing error pages
- Deprecated error code ZE10028 (Wrangler dependency) with redirects to ZE00000
Reviewed changes
Copilot reviewed 53 out of 53 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| rspress.config.ts | Added redirects for deprecated error code ZE10028 to ZE00000 |
| lib/error-codes-messages.ts | Added config category and 19 new error definitions; removed ERR_NO_WRANGLER |
| docs/errors/ze00000.mdx | Created unknown error catch-all documentation page |
| docs/errors/ze10022.mdx | Created auth forbidden error documentation |
| docs/errors/ze10023.mdx | Created invalid Module Federation config error documentation |
| docs/errors/ze10024.mdx | Created invalid app ID error documentation |
| docs/errors/ze10028.mdx | Removed deprecated Wrangler dependency error page |
| docs/errors/ze10029.mdx | Added Quick Help tip to undocumented error placeholder |
| docs/errors/ze10030.mdx | Created no response for app config error documentation |
| docs/errors/ze10031.mdx | Created no JWT error documentation |
| docs/errors/ze10032.mdx | Created JWT invalid error documentation |
| docs/errors/ze10034.mdx | Created WebSocket connection error documentation |
| docs/errors/ze10035.mdx | Created get app config error documentation |
| docs/errors/ze10036.mdx | Created Git commit hash error documentation |
| docs/errors/ze10010-ze10021.mdx | Added Quick Help tip to existing build error pages |
| docs/errors/ze20011-ze20027.mdx | Added Quick Help tip to existing deployment error pages and removed duplicate "Ask for Support" sections |
| docs/errors/ze20034.mdx | Created TLS cert altname invalid error documentation |
| docs/errors/ze20036.mdx | Created user identity error documentation |
| docs/errors/ze20037.mdx | Created max payload size exceeded error documentation |
| docs/errors/ze30026.mdx | Added Quick Help tip and standardized warning message |
| docs/errors/ze40001.mdx | Created resolve remotes error documentation |
| docs/errors/ze40003.mdx | Created cannot resolve app name with version error documentation |
| docs/errors/ze40004.mdx | Created shared package error documentation |
| docs/errors/ze40005.mdx | Created MF config missing filename error documentation |
| docs/errors/ze40006.mdx | Created missing platform error documentation |
| docs/errors/ze40035.mdx | Created HTTP error documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ERR_WEBSOCKET_CONNECTION: { | ||
| id: '034', | ||
| message: 'WebSocket connection error.', | ||
| kind: 'build', |
There was a problem hiding this comment.
Duplicate error ID '034' detected. ERR_WEBSOCKET_CONNECTION (line 248) uses id '034' but ERR_TLS_CERT_ALTNAME_INVALID (line 266) also uses id '034'. Since these are in different categories ('build' vs 'deploy'), they would map to ZE10034 and ZE20034 respectively, which might be intentional. However, there's a missing id '033' in the build category sequence (goes from 032 to 034), which suggests this may be an error. Please verify the ID assignments are correct.
| /** Git commit hash error */ | ||
| ERR_GIT_COMMIT_HASH: { | ||
| id: '036', | ||
| message: 'Git commit hash error.', | ||
| kind: 'build', | ||
| }, |
There was a problem hiding this comment.
Duplicate error ID '036' detected. ERR_GIT_COMMIT_HASH (line 260) uses id '036' but ERR_USER_IDENTITY (line 272) also uses id '036'. These are in different categories ('build' vs 'deploy'), so they would map to ZE10036 and ZE20036 respectively. However, there's a missing id '033' in the build category and id '035' in the deploy category, which suggests the numbering may be incorrect. Please verify these ID assignments are intentional.
| /** Cannot resolve app name with version */ | ||
| ERR_CANNOT_RESOLVE_APP_NAME_WITH_VERSION: { | ||
| id: '003', | ||
| message: 'Cannot resolve app name with version.', | ||
| kind: 'config', | ||
| }, |
There was a problem hiding this comment.
Missing ID '002' in the config category sequence. The config error IDs go from '001' (ERR_RESOLVE_REMOTES) directly to '003' (ERR_CANNOT_RESOLVE_APP_NAME_WITH_VERSION), skipping '002'. This creates an inconsistent numbering pattern and leaves ZE40002 undefined. Consider adding the missing error or renumbering the sequence.
| The fastest way to resolve this error is to [join our Discord](https://discord.gg/zephyrcloud) and leave a message - our team is ready to help! | ||
| ::: | ||
|
|
||
| <ErrorInfo code="ZE20037" browser /> |
There was a problem hiding this comment.
Incorrect error context. ZE20037 is a deployment error (deploy category, ID 037) about "Max payload size exceeded", but the ErrorInfo component is marked with "browser" prop. This should be "terminal" since it's a deployment error that occurs during build/deployment operations, not in the browser runtime.
| The fastest way to resolve this error is to [join our Discord](https://discord.gg/zephyrcloud) and leave a message - our team is ready to help! | ||
| ::: | ||
|
|
||
| <ErrorInfo code="ZE20036" browser /> |
There was a problem hiding this comment.
Incorrect error context. ZE20036 is a deployment error (deploy category, ID 036) about "User identity error", but the ErrorInfo component is marked with "browser" prop. This should be "terminal" since it's a deployment error that occurs during build/deployment operations, not in the browser runtime.
| The fastest way to resolve this error is to [join our Discord](https://discord.gg/zephyrcloud) and leave a message - our team is ready to help! | ||
| ::: | ||
|
|
||
| <ErrorInfo code="ZE20034" browser /> |
There was a problem hiding this comment.
Incorrect error context. ZE20034 is a deployment error (deploy category, ID 034) about "TLS cert altname invalid", but the ErrorInfo component is marked with "browser" prop. This should be "terminal" since it's a deployment error that occurs during build/deployment operations, not in the browser runtime.
What's added in this PR?
All 51 error documentation pages have been standardized with a unified format and a prominent "Quick Help" tip pointing users to the Discord community for support. Additionally, 19 missing error documentation pages were created to complete the error reference documentation.
Key Changes:
What's the issues or discussion related to this PR?
This work improves the documentation completeness and consistency, making it easier for users to find help when encountering errors. The Discord disclaimer ensures users know the fastest way to resolve issues is through community support.
Pre-PR/Merge checklist