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: Optimize document formatting and content in document sites #483

Open
yuluo-yx opened this issue Jun 12, 2024 · 0 comments
Open

docs: Optimize document formatting and content in document sites #483

yuluo-yx opened this issue Jun 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@yuluo-yx
Copy link
Collaborator

Description:

Now that we have the documentation site.
so, we need to optimize document formatting and content in document sites.

We can refer this docs guide: https://github.com/ruanyf/document-style-guide.
in addition, we can install markdownlint plugin in vscode to check md style.

If this problem occurs, it means we need to change the formatting.

image

@yuluo-yx yuluo-yx added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jun 12, 2024
LinuxSuRen pushed a commit that referenced this issue Jun 17, 2024
* chore(deps): update jenkins/jenkins docker tag to v2.427

* Update app version [skip ci]

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: github-action update-app-version <[email protected]>
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant