📚 Doc: Improve translation #2899
Conversation
emirhansirkeci
requested review from
gaby,
sixcolors,
ReneWerner87 and
efectn
and removed request for
a team
|
Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord |
WalkthroughThe recent updates focus on enhancing the documentation and code comments for the Fiber middleware, alongside upgrading the Go version requirement. These changes include renaming a middleware for consistency, fixing typos, refining API endpoint references, and improving middleware descriptions. The effort aims to improve readability and accuracy, ensuring developers have a clearer and more reliable guide. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 12
Configuration used: CodeRabbit UI
Files selected for processing (2)
- .github/README.md (1 hunks)
- .github/README_tr.md (4 hunks)
Additional comments: 9
.github/README_tr.md (3)
- 145-145: The update to API endpoint references enhances clarity and is a valuable addition to the documentation.
- 321-321: The addition of a comment explaining how to use a template is helpful for users unfamiliar with the process.
- 585-585: The enhanced description of the Basic Auth middleware provides a clearer understanding of its functionality and use cases.
.github/README.md (6)
- 565-565: The change from "Recover middleware" to "Recover Middleware" improves consistency and clarity in the documentation. Good job on making this update.
- 562-568: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [130-130]
The term "TechEmpower" is correctly used here as it refers to the TechEmpower Framework Benchmarks. No change is needed.
- 562-568: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [141-141]
The command
go mod init github.com/your/repois correctly formatted for initializing a Go module. No change is needed.
- 562-568: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [157-157]
"WebSocket" is correctly used in the context of technology and does not require a change to "Web Socket".
- 562-568: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [174-174]
The term "net/http" is correctly used here as it refers to the Go standard library package. No change is needed.
- 562-568: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [345-345]
The use of the unpaired symbol ‘"’ seems to be a false positive in this context, as the code snippet appears correctly formatted.
.github/README_tr.md
Outdated
| @@ -128,7 +128,7 @@ Bu testler [TechEmpower](https://www.techempower.com/benchmarks/#section=data-r1 | |||
|
|
|||
| ## ⚙️ Kurulum | |||
|
|
|||
| Go'nun `1.20` sürümü ([indir](https://go.dev/dl/)) veya daha yüksek bir sürüm gerekli. | |||
| Go'nun yüklü olduğundan emin olun ([indir](https://go.dev/dl/)). `1.20` veya veya daha yüksek bir sürüme sahip olmanız gerekmektedir. | |||
There was a problem hiding this comment.
The phrase "veya veya" is repeated, which seems to be a typo.
- Go'nun yüklü olduğundan emin olun ([indir](https://go.dev/dl/)). `1.20` veya veya daha yüksek bir sürüme sahip olmanız gerekmektedir.
+ Go'nun yüklü olduğundan emin olun ([indir](https://go.dev/dl/)). `1.20` veya daha yüksek bir sürüme sahip olmanız gerekmektedir.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Go'nun yüklü olduğundan emin olun ([indir](https://go.dev/dl/)). `1.20` veya veya daha yüksek bir sürüme sahip olmanız gerekmektedir. | |
| Go'nun yüklü olduğundan emin olun ([indir](https://go.dev/dl/)). `1.20` veya daha yüksek bir sürüme sahip olmanız gerekmektedir. |
| } | ||
| ``` | ||
|
|
||
| ### Recover middleware | ||
| ### Recover Middleware | ||
|
|
||
| 📖 [Recover](https://docs.gofiber.io/api/middleware/recover) | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [110-110]
Consider changing "Quickstart" to "Quick start" or "Quick-start" for better readability.
- ## ⚡️ Quickstart
+ ## ⚡️ Quick Start📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [221-221]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000") }
+ app.Listen(":3000")}📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [273-273]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) } ```
+ app.Listen(":3000"))} ```📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [313-313]
Replace the double dots with a single period for correct punctuation.
- etc..
+ etc.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [380-380]
Add a space between sentences to improve readability.
- app.Use(logger.New()) // .....
+ app.Use(logger.New()) // .....📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [405-405]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) }
+ app.Listen(":3000"))}📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [434-434]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) } ```
+ app.Listen(":3000"))} ```📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [462-462]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) } ```
+ app.Listen(":3000"))} ```📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [492-492]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) } ```
+ app.Listen(":3000"))} ```📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [526-526]
Remove the extra space before the closing parenthesis to maintain consistency in the documentation formatting.
- app.Listen(":3000")) } ```
+ app.Listen(":3000"))} ```
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- .github/README_tr.md (4 hunks)
Additional comments: 4
.github/README_tr.md (4)
- 131-131: The update to specify the Go version requirement as
1.20or higher is clear and relevant, ensuring users have the correct version for successful project setup.- 145-145: The enhancements to the documentation, including the updated list of features and middleware support, provide clearer and more detailed information for users.
- 321-321: Including a practical example of how to use a template enhances the documentation by providing clear guidance to users.
- 585-585: The updated description of the Basic Auth middleware offers a clearer and more comprehensive explanation, enhancing the documentation's usefulness for users.
|
Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord |
* Make the sentence more understandable * Add the English version of the words as the Turkish version is difficult to understand. * Improve translation * Correct the meaningless sentence * Convert first letter to uppercase * Delete repeated word
Description
As a native Turkish speaker, I noticed some parts that were strange and that I could not understand when I first read them. So I made these parts easier to understand.
Changes introduced
Type of change
Summary by CodeRabbit
Summary by CodeRabbit