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

Fix documentation link formatting in README_cn #2615

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

BrickYo
Copy link
Contributor

@BrickYo BrickYo commented Oct 18, 2024

This PR fixes the formatting of documentation and source code links in the README.

Current issue:
The links are enclosed in backticks, which causes them to be displayed as code instead of clickable links.

Changes made:

  • Removed backticks surrounding the documentation and source code links
  • Kept the HTML tags to maintain the "target="_blank" functionality

Reason for change:
This formatting error affects the usability of the README, as users cannot directly click on the links. The fix improves navigation and overall user experience when viewing the project's GitHub page.

Related files:

  • README.md

This PR fixes the formatting of documentation and source code links in the README.

Current issue:
The links are enclosed in backticks, which causes them to be displayed as code instead of clickable links.

Changes made:
- Removed backticks surrounding the documentation and source code links
- Kept the HTML <a> tags to maintain the "target="_blank" functionality

Reason for change:
This formatting error affects the usability of the README, as users cannot directly click on the links. The fix improves navigation and overall user experience when viewing the project's GitHub page.

Related files:
- README.md
Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Wauplin Wauplin merged commit e118ecc into huggingface:main Oct 21, 2024
5 of 8 checks passed
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

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.

3 participants