📝 [docs] Update documentation with new features and translations#95
Conversation
- Add docs/deployment/production.ja.md and docs/deployment/security.ja.md - Link Japanese deployment guides in README.ja.md and docs/README.md - Add export/sharing info to AGENTS.md, FAQ, and Troubleshooting guide Co-authored-by: linkalls <72078864+linkalls@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
There was a problem hiding this comment.
Pull request overview
Updates the project documentation to cover the new session export/sharing feature and adds Japanese translations for deployment/security docs, with navigation links updated accordingly.
Changes:
- Added FAQ + troubleshooting guidance for exporting/sharing sessions (Markdown/JSON) and common failure modes.
- Added Japanese translations for production deployment and security best-practices documentation.
- Updated documentation index/README links to include the new Japanese docs and export hook reference in AGENTS guidance.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/troubleshooting.md | Adds an “Export & Sharing Issues” troubleshooting section. |
| docs/guides/faq.md | Adds an FAQ entry explaining how to export/share sessions. |
| docs/deployment/security.ja.md | New Japanese security best-practices document. |
| docs/deployment/production.ja.md | New Japanese production deployment guide. |
| docs/README.md | Adds links to Japanese deployment/security docs from the docs index. |
| README.ja.md | Adds quick links to the new Japanese deployment/security docs. |
| AGENTS.md | Documents the hooks/use-export-session.ts hook as the source of truth for export/sharing behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```typescript | ||
| // ユーザー認証レイヤーの追加 | ||
| - OAuth 2.0 / OIDC | ||
| - 多要素認証 (MFA) | ||
| - セッション管理 | ||
| ``` | ||
|
|
||
| 2. **ネットワークセキュリティ** | ||
| ```typescript | ||
| // 証明書のピン留めを追加 | ||
| - SSL 証明書の検証 | ||
| - タイムアウトポリシーの実装 | ||
| - エクスポネンシャルバックオフによる再試行ロジックの追加 | ||
| ``` | ||
|
|
||
| 3. **データ保護** | ||
| ```typescript | ||
| // 機密データの暗号化 | ||
| - ローカルキャッシュの暗号化 | ||
| - データ保持ポリシーの実装 | ||
| - データエクスポート / 削除機能の追加 | ||
| ``` |
There was a problem hiding this comment.
The “recommended additional security” sections are formatted as a typescript code block but contain Markdown bullet items (e.g., - OAuth 2.0 / OIDC). This renders as code and reads like invalid TypeScript. Consider replacing these fenced blocks with normal Markdown lists, or provide a real code snippet and use a more appropriate fence language (or none).
| ```typescript | |
| // ユーザー認証レイヤーの追加 | |
| - OAuth 2.0 / OIDC | |
| - 多要素認証 (MFA) | |
| - セッション管理 | |
| ``` | |
| 2. **ネットワークセキュリティ** | |
| ```typescript | |
| // 証明書のピン留めを追加 | |
| - SSL 証明書の検証 | |
| - タイムアウトポリシーの実装 | |
| - エクスポネンシャルバックオフによる再試行ロジックの追加 | |
| ``` | |
| 3. **データ保護** | |
| ```typescript | |
| // 機密データの暗号化 | |
| - ローカルキャッシュの暗号化 | |
| - データ保持ポリシーの実装 | |
| - データエクスポート / 削除機能の追加 | |
| ``` | |
| ユーザー認証レイヤーの追加： | |
| - OAuth 2.0 / OIDC | |
| - 多要素認証 (MFA) | |
| - セッション管理 | |
| 2. **ネットワークセキュリティ** | |
| 証明書のピン留めを追加： | |
| - SSL 証明書の検証 | |
| - タイムアウトポリシーの実装 | |
| - エクスポネンシャルバックオフによる再試行ロジックの追加 | |
| 3. **データ保護** | |
| 機密データの暗号化： | |
| - ローカルキャッシュの暗号化 | |
| - データ保持ポリシーの実装 | |
| - データエクスポート / 削除機能の追加 |
| セキュリティの脆弱性を発見した場合は： | ||
|
|
||
| 1. **絶対に**公開の GitHub Issue を開かないでください | ||
| 2. セキュリティに関する懸念事項は [あなたの連絡先メールアドレス] にメールしてください |
There was a problem hiding this comment.
This line still contains a placeholder contact address ([あなたの連絡先メールアドレス]), which makes the vulnerability reporting instructions unusable. Replace it with the project’s actual security contact (or point to GitHub Security Advisories / a SECURITY.md process) so reporters have a real channel.
| 2. セキュリティに関する懸念事項は [あなたの連絡先メールアドレス] にメールしてください | |
| 2. このリポジトリの GitHub Security Advisories の private vulnerability reporting 機能、または `SECURITY.md` に記載の手順に従って非公開で報告してください |
This PR fulfills the goal to "update all documents" by:
AGENTS.md,docs/guides/faq.md, anddocs/guides/troubleshooting.md.docs/deployment/production.ja.mdanddocs/deployment/security.ja.md).PR created automatically by Jules for task 1749476861508772671 started by @linkalls