Skip to content

Docs: Code blocks writing standards #2821

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

Closed
xiaodong2008 opened this issue Apr 24, 2024 · 2 comments
Closed

Docs: Code blocks writing standards #2821

xiaodong2008 opened this issue Apr 24, 2024 · 2 comments

Comments

@xiaodong2008
Copy link
Contributor

Refers to the pages in docs, I think that the first letter of text(like button) in code blocks should be capitalised.

For example, there is a violation of writing standards in /guide/components/attrs, it should be write like this:

- <button class="large">click me</button>
+ <button class="large">Click Me</button>
@bencodezen bencodezen added the good first issue Good for newcomers label Apr 25, 2024
@bencodezen
Copy link
Member

bencodezen commented Apr 25, 2024

I think you're totally right @xiaodong2008! Appreciate the call out.

Do you have any interest in contributing a PR to standardize this?

@xiaodong2008
Copy link
Contributor Author

Sure! I will fix this soon 🥰

bencodezen pushed a commit that referenced this issue Apr 30, 2024
* docs: fix writing mistakes in letter case

* docs: revert removing 'is' from 'count is'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants