Skip to content

Conversation

@xianshujun
Copy link
Contributor

@xianshujun xianshujun commented Jun 12, 2025

close #483

What type of PR is this?
This is a docs type PR, as it focuses on improving the formatting and style of the documentation files.

What this PR does / why we need it?
This PR addresses several issues related to the formatting and linting of Markdown files in the documentation site. Specifically:

  • Improved Document Formatting:

    • Adjusted heading hierarchy to follow consistent standards.
    • Fixed list formatting issues (e.g., unordered vs. ordered lists).
    • Ensured all links and images are properly formatted.
  • Fixed Linting Issues:

    • Used the markdownlint tool to identify and fix style violations.
    • Resolved issues such as missing spaces after headings, incorrect indentation.

These changes improve the overall quality and consistency of the documentation, making it easier for users to read and understand.

Which issue(s) this PR fixes?
This PR resolves the following issue:

Additional Notes:

  • All changes have been validated using the markdownlint plugin in VSCode.
  • Local tests (make test) were run successfully before submitting this PR.

@CLAassistant
Copy link

CLAassistant commented Jun 12, 2025

CLA assistant check
All committers have signed the CLA.

@xianshujun xianshujun force-pushed the fix-document-formatting-483 branch from c254f23 to 5c9b0eb Compare June 12, 2025 02:56
@sonarqubecloud
Copy link

Copy link
Owner

@LinuxSuRen LinuxSuRen left a comment

Choose a reason for hiding this comment

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

LGTM

@LinuxSuRen LinuxSuRen added documentation Improvements or additions to documentation skip-changelog labels Jun 12, 2025
@LinuxSuRen LinuxSuRen merged commit 5fadf66 into LinuxSuRen:master Jun 12, 2025
14 checks passed
@LinuxSuRen LinuxSuRen added the ospp 开源之夏 https://summer-ospp.ac.cn/ label Jun 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ospp 开源之夏 https://summer-ospp.ac.cn/ skip-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Optimize document formatting and content in document sites

3 participants