Skip to content
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

docs: fix broken link and improve readability #1176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fyvri
Copy link

@fyvri fyvri commented Jan 31, 2025

This PR includes several minor but important updates to improve readability, consistency, and correctness across the documentation. Below is a summary of the changes:

  1. HTML Entity Fix:
    Replaced &nbsp&nbsp with    to ensure proper usage of HTML entities.
  2. Spacing Around Pipes in Links:
    Added spaces around pipes (|) in link groupings for better readability. For example: EN|ZHEN | ZH.
  3. Word Choice Improvements:
    • Replaced "Temporarily" with "Currently" where appropriate to better reflect ongoing states or conditions.
    • Clarified instances of "advise" by replacing them with "recommend," which is more precise in context.
  4. Citation Formatting:
    Added ```BibTeX to citation blocks for consistency and easier identification of BibTeX content.
  5. Broken Link Fix:
    Updated a broken link from assets/wechat.png to its full path: https://github.com/QwenLM/Qwen/blob/main/assets/wechat.png.

These changes collectively enhance the clarity, accuracy, and maintainability of the documentation. Let me know if there are any additional suggestions! 🙌

@fyvri fyvri force-pushed the docs/improve-readability branch from 68e3acc to d2b56e2 Compare January 31, 2025 08:33
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.

1 participant