docs(output): restructure importPath validation and sync zh translation - #3658
Conversation
Nest the "Validation of importPath" section under ### importPath as an H4 subsection instead of a sibling H3 placed after splitByTags. The anchor #validation-of-importpath is preserved. Sync the Chinese translation (zh/reference/configuration/output.mdx) with content from orval-labs#3548, orval-labs#3595, orval-labs#3613, and orval-labs#3618 that was only added to the English docs: - Expand ## schemas with String/Object forms, property table, importPath subsection (incl. requirements + validation), and splitByTags subsection - Add schemasImportPath row to the Faker generator table and a dedicated #### schemasImportPath subsection - Add missing MSW and Faker generator table rows for full zh/en parity (delay, useExamples, generateEachHttpStatus, locale, etc.)
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe EN docs move ChangesOutput Configuration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/content/docs/zh/reference/configuration/output.mdx`:
- Line 43: The Chinese documentation page still contains untranslated English
headings and link text, so update the remaining labels in the output
configuration reference to Chinese. In the markdown sections around the
String/Object forms and the importPath validation subsection, as well as the
link text near the later referenced lines, replace the English headings and link
label with consistent zh wording while keeping the existing structure and
anchors intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 85218a2e-2d22-4a49-9cbe-6cd8dd641a85
📒 Files selected for processing (2)
docs/content/docs/reference/configuration/output.mdxdocs/content/docs/zh/reference/configuration/output.mdx
…nese Translate descriptive headings introduced in the previous commit from English to Chinese, keeping config property name headings (importPath, splitByTags) in English per existing convention: - "String form" → "字符串形式" - "Object form" → "对象形式" - "Validation of importPath" → "importPath 校验" (link + heading updated)
|
Build failing |
|
@melloware network issue. Just restart the job. |
Summary
Restructures the
Validation of importPathsection in the English output reference and syncs the Chinese translation with content from #3548, #3595, #3613, and #3618 that was only added to the English docs.Changes
English (
reference/configuration/output.mdx)Validation of importPathunder### importPathas an####subsection instead of a sibling###placed aftersplitByTags. The section is logically a sub-aspect ofimportPath, not a peer property of theschemasobject.#validation-of-importpathanchor is preserved (rehype-slug derives it from heading text, not level).Chinese (
zh/reference/configuration/output.mdx)## schemaswith String/Object forms, property table,### importPathsubsection (incl. requirements +#### Validation), and### splitByTagssubsection — content from feat(core): add schemas.importPath for package import specifiers #3548, feat(schemas): add splitByTags option to organize schemas by tag #3595, feat(core): make output.schemas.type optional, defaulting to typescript #3613.schemasandschemasImportPathrows to the Faker generator table plus a dedicated#### schemasImportPathsubsection — content from feat(mock): add schemasImportPath to faker generator #3618.delay,delayFunctionLazyExecute,baseUrl,useExamples,generateEachHttpStatus,locale,preferredContentType,operationResponses,arrayItems) for full zh/en parity.Verification
bun run types:check(fumadocs-mdx + tsc) — passesbun run i18n:check— passesSummary by CodeRabbit
importPathvalidation subsection (including trimming/empty checks and relative/absolute path-like rules) and reorganized the surrounding sections.schemas/schemasImportPath, default behavior, tag-based directory organization, examples, and compatibility notes.