Skip to content

docs: 日本語版についてのセクションを追加#329

Open
3w36zj6 wants to merge 14 commits intomainfrom
feature/add-about-project-section
Open

docs: 日本語版についてのセクションを追加#329
3w36zj6 wants to merge 14 commits intomainfrom
feature/add-about-project-section

Conversation

@3w36zj6
Copy link
Member

@3w36zj6 3w36zj6 commented Oct 2, 2025

このPRでは、「Typstドキュメント日本語版」のプロジェクトそのものについてを紹介するセクションを追加します。プロジェクトそのものについての説明を一元管理することによってメンテナンスが簡単になり、Webサイトの利用者にも情報を伝えやすくなると考えます。

@3w36zj6 3w36zj6 requested a review from Copilot October 2, 2025 13:19
Copy link
Contributor

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 adds a new "About" section to the Japanese Typst documentation website to centralize information about the translation project itself. This reorganization improves maintainability and makes project information more accessible to users.

  • Adds a new "About" section with project overview and contribution guidelines
  • Reorganizes the main overview page to reference the new About section
  • Updates README to focus on project description rather than detailed contributor information

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/about/welcome.md New main About page with project overview and FAQ
docs/about/contributing.md Symlink to CONTRIBUTING.md for contribution guidelines
docs/about/translating_guidelines.md Symlink to TRANSLATING_GUIDELINES.md for translation guidelines
docs/src/lib.rs Adds about_pages function and integration
docs/src/link.rs Adds $about link resolver
docs/overview.md Simplified to reference new About section
website/translation-status.json Adds translation status for new About pages
docs/src/html.rs Adds LinkType::Shortcut support
CONTRIBUTING.md Adds frontmatter for markdown processing
TRANSLATING_GUIDELINES.md Adds frontmatter for markdown processing
README.md Streamlined project description and contributor section

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 Oct 2, 2025

「貢献ガイドライン」と「翻訳ガイドライン」については、一旦シンボリックリンクで/docs/配下に配置しました。
これらはWebサイト上以外の方法で読まれることを想定しているため、サイト内リンクの省略記法を使用していませんが、Webサイト上でのみ読まれることを想定してファイルを移動することもできると思います。こちらご意見はありますでしょうか?

@kimushun1101
Copy link
Member

「貢献ガイドライン」と「翻訳ガイドライン」については、一旦シンボリックリンクで/docs/配下に配置しました。 これらはWebサイト上以外の方法で読まれることを想定しているため、サイト内リンクの省略記法を使用していませんが、Webサイト上でのみ読まれることを想定してファイルを移動することもできると思います。こちらご意見はありますでしょうか?

ひとまず、こちらの対応で問題ないと思います。
基本的にGitHubを使う人がGitHubやクローンしたソースコードを見ることで想定されているものだと思います。Webサイト上で見ることはあくまでオプションという立ち位置でよいと思います。オプションとはいえアクセスがしやすいのは大変助かります。

@3w36zj6 3w36zj6 marked this pull request as draft February 16, 2026 07:39
@3w36zj6 3w36zj6 marked this pull request as ready for review March 15, 2026 04:59
Copy link
Contributor

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

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

@3w36zj6 3w36zj6 requested a review from Copilot March 15, 2026 15:42
@3w36zj6 3w36zj6 force-pushed the feature/add-about-project-section branch from ec9795c to a792055 Compare March 15, 2026 15:45
Copy link
Contributor

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

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

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.

5 participants