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

[Feature] Improve official document title specifications #3507

Open
2 of 3 tasks
caicancai opened this issue Jan 22, 2024 · 3 comments
Open
2 of 3 tasks

[Feature] Improve official document title specifications #3507

caicancai opened this issue Jan 22, 2024 · 3 comments
Labels
DOCS good first issue Good for newcomers

Comments

@caicancai
Copy link
Member

caicancai commented Jan 22, 2024

Search before asking

  • I had searched in the feature and found no similar feature requirement.

Description

Regarding the User guide, the document title can be further divided. I think it can be roughly divided into three subtitles.
One is the user's quick start,
the second is the use of the platform,
the third is the developer guide.

This is just my personal opinion. Contributors can also split it according to their own ideas, as long as it is beneficial to readers.

微信图片_20240122161813

Usage Scenario

No response

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@caicancai caicancai added the good first issue Good for newcomers label Jan 22, 2024
@VampireAchao
Copy link
Contributor

assign me

@caicancai
Copy link
Member Author

Thank you

@caicancai caicancai added the DOCS label Jan 22, 2024
@VampireAchao
Copy link
Contributor

Unassign me please, I'd like to mention a note of caution regarding changes to the documentation headings. Altering titles may also change the associated links, and we should try to avoid this to prevent link rot. If changes are unavoidable, we must ensure to search and update any references to avoid broken links in the blogs that could lead to 404 errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOCS good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants