-
Notifications
You must be signed in to change notification settings - Fork 180
docs: update markdown style for different language README.md
#146
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -277,7 +277,7 @@ app.add_page(index) | |
| في سعينا لإنشاء تطبيقات تكتب نفسها، غصنا بعمق في متاهة من أدوات البرمجة وإطارات العمل والمكتبات. شملت تجاربنا جميع النماذج اللغوية الكبيرة (LLMs)، وآلاف المطالبات، وكل إطار عمل تطوير ويب رئيسي، من React إلى Streamlit. | ||
|
|
||
| الإدراك | ||
| > [!نصيحة] | ||
| > [!TIP] | ||
| > وجدنا أن اختيار الإطار التطبيقي الأساسي يؤثر بشكل كبير على كفاءة توليد الكود، بغض النظر عن نماذج اللغة الكبيرة (LLMs)، أو الأوامر، أو طرق التحسين الدقيق. | ||
|
|
||
| في البداية، بدا مرونة Reflex واعدًا، متوافقًا مع العديد من متطلباتنا. ومع ذلك، مع تجربتنا لتطبيقات ويب مختلفة، ظهرت فجوات ميزات حاسمة. ولسد هذه الفجوات، احتجنا إلى كتابة "كود لصق" موسع، مما أبطأ عملية التطوير بشكل كبير. | ||
|
Comment on lines
277
to
283
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tip Codebase Verification The executed script has identified multiple instances of old tip markers across various language-specific README.md files within the Given this evidence, it's clear that the review comment suggesting the update to a universal tip marker has not been fully implemented across all relevant documentation files. This inconsistency could lead to confusion and a lack of uniformity in the documentation's presentation. Analysis chain
Overall, the documentation appears well-structured and the markdown is correctly used. The change to a universal tip marker Scripts ExecutedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Search for old tip markers in all README.md files to ensure they've been replaced.
rg '\[!\w+\]' -g 'docs/**/*.md' | grep -v '\[!TIP\]'
Length of output: 1139 |
||
|
|
||
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.
The change from
[!СОВЕТ]to[!TIP]aligns with the PR's objective to standardize the markdown style for tips across different language versions of the README.md documentation. This should enhance consistency across the documentation. However, it's important to ensure that this change does not negatively impact the readability for Russian-speaking users. Consider adding a brief explanation or translation of "TIP" in Russian the first time it appears in the document to ensure clarity and maintain accessibility.