-
Notifications
You must be signed in to change notification settings - Fork 3
章・節の参照の表記を統一 #908
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
base: fix-reference-term
Are you sure you want to change the base?
章・節の参照の表記を統一 #908
Conversation
Deploying utcode-learn with
|
| Latest commit: |
a82863c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1a7c3167.utcode-learn.pages.dev |
| Branch Preview URL: | https://unify-section-reference-form.utcode-learn.pages.dev |
e1842a3 to
d88a5cc
Compare
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 standardizes the notation for chapter and section references throughout the Japanese documentation. Previously, references used inconsistent formats like "XXXの節" (the section of XXX), "「XXX」の節" (the section of "XXX"), and bare links. The new standard uses the exact page titles as link text without additional qualifiers.
Changes:
- Updated 11 documentation files to use consistent reference notation
- Changed from patterns like "XXXの節で" to "Page Titleで" using exact page titles
- Standardized references to chapters and sections across the documentation
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/5-team-development/01-git-workflow/index.mdx | Updated references to Git and GitHub sections using exact page titles |
| docs/4-advanced/04-react/index.mdx | Removed "節" (section) suffix from reference to "オブジェクトの参照" |
| docs/4-advanced/02-bundler/index.mdx | Updated reference to server section using exact page title |
| docs/3-web-servers/13-deploy-on-render/index.mdx | Removed "の節" from database reference |
| docs/3-web-servers/07-fetch-api-post/index.mdx | Updated reference to server section removing "の節では" pattern |
| docs/3-web-servers/05-server/index.mdx | Changed chapter reference to use exact title without quotes |
| docs/3-web-servers/03-node-js/index.mdx | Updated reference to inspector section (with minor inconsistency) |
| docs/2-browser-apps/06-project/index.mdx | Changed "DOMの節で" to just use page title "DOM" |
| docs/2-browser-apps/04-anonymous-function/index.mdx | Removed "の節で" from events reference |
| docs/2-browser-apps/03-class/index.mdx | Updated DOM reference removing "の節" |
| docs/1-trial-session/14-events/index.mdx | Changed "先ほどのDOMの節で" to "先ほど[DOM]で" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Node.jsのデバッグ | ||
|
|
||
| [ブラウザの開発者ツールを利用する](/docs/browser-apps/inspector/)節でJavaScriptのデバッグを行ったのと同様に、Node.jsでは、VS Code標準の機能を用いてデバッグを行えます。 | ||
| [ブラウザの開発者ツール](/docs/browser-apps/inspector/)でJavaScriptのデバッグを行ったのと同様に、Node.jsでは、VS Code標準の機能を用いてデバッグを行えます。 |
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.
タイトルが間違っていたため、ついでに修正しました。cf.
| title: ブラウザの開発者ツール |
| ### <Term>モジュールバンドラ</Term> | ||
|
|
||
| 通常、規模の大きなプログラムは、見通しが良くなるよう複数のファイルに分割されます。HTMLから複数のJavaScriptを読み込むためには`script`タグを並べれば良いですが、[HTTPサーバー](/docs/web-servers/server/)の節で学んだように、`script`タグの数だけ<Term>HTTPリクエスト</Term>が発行されてしまうため非効率的です。 | ||
| 通常、規模の大きなプログラムは、見通しが良くなるよう複数のファイルに分割されます。HTMLから複数のJavaScriptを読み込むためには`script`タグを並べれば良いですが、[Expressによるサーバー構築](/docs/web-servers/server/)で学んだように、`script`タグの数だけ<Term>HTTPリクエスト</Term>が発行されてしまうため非効率的です。 |
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.
タイトルが間違っていたため、ついでに修正しました。
| ## コミットが記録される仕組み | ||
|
|
||
| Gitの節では、Gitのコミットに一意のIDが割り当てられることを説明しました。実は、**コミットIDは、次の情報から計算可能です**。つまり、次の情報が完全に一致しているのであれば、どのような環境でコミットを行なっても同じコミットIDが割り当てられます。逆に、次の情報のうち一つでも異なるものがあれば、全く違うコミットIDが割り当てられます。 | ||
| [Gitを用いたバージョン管理](/docs/web-servers/git/)では、Gitのコミットに一意のIDが割り当てられることを説明しました。実は、**コミットIDは、次の情報から計算可能です**。つまり、次の情報が完全に一致しているのであれば、どのような環境でコミットを行なっても同じコミットIDが割り当てられます。逆に、次の情報のうち一つでも異なるものがあれば、全く違うコミットIDが割り当てられます。 |
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.
同様
| ## リモートブランチ | ||
|
|
||
| GitとGitHubの節では、自分のPCに置かれたリポジトリ (ローカルリポジトリ) とGitHub上のリポジトリ (リモートリポジトリ) を接続しました。`git push origin master` コマンドを行ったときのGitの動作を確認しておきましょう。 | ||
| [GitとGitHubを用いた共同開発](/docs/web-servers/github/)では、自分のPCに置かれたリポジトリ (ローカルリポジトリ) とGitHub上のリポジトリ (リモートリポジトリ) を接続しました。`git push origin master` コマンドを行ったときのGitの動作を確認しておきましょう。 |
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.
同様
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
Copilot reviewed 11 out of 11 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
章・節の参照の表記がバラバラだったため、統一しました。 cf. #890 (comment)
当初は、章・節の参照の表記として次の3通りを検討し、2つめのような表記とすることを考えていました。
実は、[「DOM」の節](/docs/trial-session/dom/)で使用した実は、[DOMの節](/docs/trial-session/dom/)で使用した実は、[DOM](/docs/trial-session/dom/)の節で使用したしかし、節名などが名詞で終わらない場合には、次のような表記となってしまい切れ目がわかりにくくなってしまうという問題があります。
他のドキュメントでの参照の表記方法を踏まえ、一旦次のような表記にしてみました。
cf.
https://github.com/mdn/translated-content/blob/8769488c3bbf167fe489cd3cbb5a09b3f111cde5/files/ja/learn_web_development/getting_started/environment_setup/browsing_the_web/index.md?plain=1#L13
https://github.com/mdn/translated-content/blob/8769488c3bbf167fe489cd3cbb5a09b3f111cde5/files/ja/learn_web_development/getting_started/environment_setup/code_editors/index.md?plain=1#L55
https://github.com/yytypescript/book/blob/889fb5f620b1df2b52555f8d7c4fa6c59321f57c/docs/tutorials/react-like-button-tutorial.md?plain=1#L116