Skip to content

docs(output): restructure importPath validation and sync zh translation - #3658

Merged
melloware merged 2 commits into
orval-labs:masterfrom
aqeelat:docs/importpath-validation-restructure-zh-sync
Jun 28, 2026
Merged

docs(output): restructure importPath validation and sync zh translation#3658
melloware merged 2 commits into
orval-labs:masterfrom
aqeelat:docs/importpath-validation-restructure-zh-sync

Conversation

@aqeelat

@aqeelat aqeelat commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Restructures the Validation of importPath section 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)

  • Nest Validation of importPath under ### importPath as an #### subsection instead of a sibling ### placed after splitByTags. The section is logically a sub-aspect of importPath, not a peer property of the schemas object.
  • Drop "below" from the Requirements bullet pointer since the section is now immediately adjacent.
  • The #validation-of-importpath anchor is preserved (rehype-slug derives it from heading text, not level).

Chinese (zh/reference/configuration/output.mdx)

Verification

  • bun run types:check (fumadocs-mdx + tsc) — passes
  • bun run i18n:check — passes

Summary by CodeRabbit

  • Documentation
    • Updated configuration reference for output schema settings, adding an explicit importPath validation subsection (including trimming/empty checks and relative/absolute path-like rules) and reorganized the surrounding sections.
    • Expanded the Chinese documentation with detailed guidance for schemas/schemasImportPath, default behavior, tag-based directory organization, examples, and compatibility notes.
    • Added and expanded generator option references for MSW and Faker, including response timing/delay behavior, base URL, examples, HTTP status handling, locale, and preferred content type.

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.)
@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7ffa75d7-f664-47f8-8501-fc7d749fb878

📥 Commits

Reviewing files that changed from the base of the PR and between f22325d and dc0d9c2.

📒 Files selected for processing (1)
  • docs/content/docs/zh/reference/configuration/output.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/content/docs/zh/reference/configuration/output.mdx

📝 Walkthrough

Walkthrough

The EN docs move importPath validation under schemas.importPath. The ZH docs expand schemas, MSW generator options, and Faker generator options, including a new schemasImportPath subsection.

Changes

Output Configuration Documentation

Layer / File(s) Summary
EN: importPath validation reorganization
docs/content/docs/reference/configuration/output.mdx
Adds a Validation of importPath subsection under schemas.importPath and removes the earlier standalone validation block before operationSchemas.
ZH: schemas full documentation
docs/content/docs/zh/reference/configuration/output.mdx
Expands schemas documentation with default values, String/Object forms, importPath rules and validation, and splitByTags organization details.
ZH: MSW and Faker generator options
docs/content/docs/zh/reference/configuration/output.mdx
Adds MSW option fields and expands Faker options with schemasImportPath plus related configuration and import examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs with a gentle thump,
Moved validation where it fits the jump.
The ZH pages bloomed with fresh new light,
MSW and Faker now read just right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main changes: restructuring importPath validation and syncing the Chinese documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4a3e7fe and f22325d.

📒 Files selected for processing (2)
  • docs/content/docs/reference/configuration/output.mdx
  • docs/content/docs/zh/reference/configuration/output.mdx

Comment thread docs/content/docs/zh/reference/configuration/output.mdx Outdated
…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)
@melloware

Copy link
Copy Markdown
Collaborator

Build failing

@aqeelat

aqeelat commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

@melloware network issue. Just restart the job.

@melloware
melloware merged commit 703a904 into orval-labs:master Jun 28, 2026
3 of 5 checks passed
@aqeelat
aqeelat deleted the docs/importpath-validation-restructure-zh-sync branch July 15, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants