-
Notifications
You must be signed in to change notification settings - Fork 13
docs: translate SSG documentation comments to English #283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: translate SSG documentation comments to English #283
Conversation
There was a problem hiding this 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.
I think everything is fine, but could you please do a quick review? @YDX-2147483647 @Its-Just-Nans |
Hi yes, my review is below :) |
There was a problem hiding this 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
// biome-ignore lint/security/noDangerouslySetInnerHtml: pagefindで生成されたスクリプトを実行する - The README https://github.com/typst-jp/docs/blob/main/website/README.md is still not in English, is that normal?
you can check with
# using https://github.com/BurntSushi/ripgrep
cd website
rg -uu '[^\x00-\x7F]'
Co-authored-by: Its-Just-Nans <[email protected]>
The README is currently being worked on at #275. |
There was a problem hiding this 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
andoutline
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.
Co-authored-by: Y.D.X. <[email protected]>
Co-authored-by: Y.D.X. <[email protected]>
Co-authored-by: Y.D.X. <[email protected]>
I appreciate your review. |
cf. #233