Skip to content

Conversation

3w36zj6
Copy link
Member

@3w36zj6 3w36zj6 commented Sep 2, 2025

cf. #233

@3w36zj6 3w36zj6 requested a review from Copilot September 2, 2025 22:01
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR translates Japanese documentation comments and JSDoc descriptions to English throughout the website codebase. The changes focus on improving code readability for English-speaking developers by converting all Japanese comments, function documentation, test descriptions, and schema descriptions to their English equivalents.

  • Translates JSDoc comments for utility functions handling translation status, page type checking, and document flattening
  • Updates test descriptions from Japanese to English across multiple test files
  • Converts JSON schema descriptions and inline code comments to English

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/translation-status.schema.json Updates JSON schema title and descriptions from Japanese to English
website/src/utils/translationStatus.ts Translates JSDoc comments for translation management functions
website/src/utils/translationStatus.test.ts Converts test descriptions and inline comments to English
website/src/utils/isPageOfKind.ts Translates JSDoc documentation for type guard function
website/src/utils/isPageOfKind.test.ts Updates test descriptions and failure messages to English
website/src/utils/flattenDocs.ts Translates function documentation and inline comments
website/src/utils/flattenDocs.test.ts Converts all test descriptions to English
website/src/types/model.ts Updates type definition comments to English
website/src/index.tsx Translates inline comments about documentation generation
website/src/globals.css Converts CSS comments to English
website/src/components/ui/type2href.ts Translates JSDoc comments for type-to-link function
website/src/components/ui/genPath.ts Updates function documentation to English
website/src/components/ui/HtmlContent.tsx Translates biome-ignore comment
website/.env.example Converts environment variable comment to English

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@3w36zj6
Copy link
Member Author

3w36zj6 commented Sep 2, 2025

I think everything is fine, but could you please do a quick review? @YDX-2147483647 @Its-Just-Nans

@Its-Just-Nans
Copy link
Contributor

Its-Just-Nans commented Sep 2, 2025

Hi yes, my review is below :)

Copy link
Contributor

@Its-Just-Nans Its-Just-Nans left a comment

Choose a reason for hiding this comment

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

LGTM except

two reviews

you can check with

# using https://github.com/BurntSushi/ripgrep
cd website
rg -uu '[^\x00-\x7F]'

Co-authored-by: Its-Just-Nans <[email protected]>
@3w36zj6
Copy link
Member Author

3w36zj6 commented Sep 3, 2025

The README is currently being worked on at #275.

Copy link
Contributor

@YDX-2147483647 YDX-2147483647 left a comment

Choose a reason for hiding this comment

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

Only some minor issues that can be changed or ignored.

  • page and outline might be confused with functions of the same names in typst. Better to restore the original description.
  • Some tenses and writing styles are inconsistent throughout, but I think they're fine for dev doc comments. No need for modification.

@3w36zj6
Copy link
Member Author

3w36zj6 commented Sep 3, 2025

I appreciate your review.

@3w36zj6 3w36zj6 merged commit 4e3161c into main Sep 3, 2025
5 checks passed
@3w36zj6 3w36zj6 deleted the feature/translate-ssg-documentation-comments-to-english branch September 3, 2025 02:05
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.

3 participants