zhangshenghang commented on PR #10351:
URL: https://github.com/apache/seatunnel/pull/10351#issuecomment-3758698729
<!-- code-pr-reviewer -->
- **docs/sidebars.js:55-80** - Developer Guide documentation was completely
removed without explanation. The entire category is deleted from the sidebar
and 11 developer docs under `docs/en/developer` and `docs/zh/developer` are
gone. This negatively impacts contributor onboarding and signals the project
doesn't welcome external contributions.
- **docs/sidebars.js:1-262** - Breaking URL changes lack migration guidance.
The PR renames directories (`connector-v2` → `connectors`) and removes
documentation categories but provides no URL redirect configuration or
migration guide. External websites, blogs, and tutorials referencing old URLs
will break, affecting SEO and user experience.
- **docs/sidebars.js:78-101** - Changed from `autogenerated` to manual item
listing increases maintenance burden. Previously `{"type": "autogenerated",
"dirName": "..."}` now requires manually listing each path like
`"getting-started/locally/deployment"`. Adding new documentation requires
manual config updates, risking omissions or typos.
- **PR description** - Lacks detailed change explanation. Only states
"related #10262, document structure adjustment" without listing URL changes,
deletion rationale, or migration guidance. This hinders PR review and user
awareness of breaking changes.
- **docs/en/transforms/*.md** - Internal link references need comprehensive
validation. Path restructuring changed many relative links (e.g.,
`../common-options/common-options.md`), but without automated link checking,
broken references may exist affecting documentation usability.
- **AllFileSpecificationCheckTest.java:110-115** - Test file path whitelist
updates need completeness verification. Only 2 paths updated for
`common-options.md`, but other documentation path changes may not be
synchronized, potentially causing CI test failures.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
