docs: write test framework migration document#265
Conversation
WalkthroughAdds two new documentation files: an English guide at itdoc-doc/docs/guides/test-framework-migration.mdx and a Korean translation at itdoc-doc/i18n/ko/docusaurus-plugin-content-docs/current/guides/test-framework-migration.mdx. Both files provide a migration guide for converting Mocha/Jest end-to-end tests to Itdoc format, covering rationale, key differences, step-by-step migration workflow, before/after JavaScript and TypeScript examples, Itdoc DSL usage (describeAPI, itDoc, HttpMethod, HttpStatus, field, header helpers), patterns for params and auth, a migration checklist, troubleshooting, and links/resources. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Files are homogeneous documentation additions; review should focus on accuracy and consistency of examples and localization. Areas to check:
Possibly related issues
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🧰 Additional context used🪛 Gitleaks (8.28.0)itdoc-doc/docs/guides/test-framework-migration.mdx[high] 527-527: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key) Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
itdoc-doc/docs/guides/test-framework-migration.mdx(1 hunks)itdoc-doc/i18n/ko/docusaurus-plugin-content-docs/current/guides/test-framework-migration.mdx(1 hunks)
itdoc-doc/i18n/ko/docusaurus-plugin-content-docs/current/guides/test-framework-migration.mdx
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
itdoc-doc/docs/guides/test-framework-migration.mdx(1 hunks)itdoc-doc/i18n/ko/docusaurus-plugin-content-docs/current/guides/test-framework-migration.mdx(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
itdoc-doc/docs/guides/test-framework-migration.mdx
[high] 527-527: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
itdoc-doc/i18n/ko/docusaurus-plugin-content-docs/current/guides/test-framework-migration.mdx
Show resolved
Hide resolved
PENEKhun
left a comment
There was a problem hiding this comment.
ko
고생하셨습니다!
사용자들이 이미 작성해둔 supertest를 itdoc으로 마이그레이션하기 한층 쉬워질 것 같네요 👍
제안 1
Test Framework Migration Guide라는 제목 보단,
Migration guide from your e2e tests
이런식의 제목이 어떨까요?
필수는 아니니 직접 잘 판단해 주시면 됩니다.
en
Great work!
This will definitely make it much easier for users to migrate their existing supertest code to itdoc 👍
Suggestion 1
Instead of the title Test Framework Migration Guide, how about something like:
migration guide from your e2e tests
What do you think?
Summary by CodeRabbit