Enforce docs being prettier'ed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Change Request
This repository is ONLY used to solve problems related to DOCS-CN.
For other issues (TiDB, TiKV, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
- Describe what you find is inappropriate or missing in the existing docs.
Now we use lints in CI. It covers some limited rules and cannot fix problems automatically.
- Describe your suggestion or addition.
We can additionally introduce a Prettier diff, that requires everyone to run prettier for all docs. There are Prettier extensions for VSCode that can be triggered on-save. This keeps the doc with a unified look. You will no longer see changes like:
- xxxx -> * xxxx
- Provide some reference materials (documents, websites, etc) if you could.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No specific files or tests are named. Start by locating the existing CI lint configuration and the documentation tree, then review how Prettier would be applied to all docs. Done means CI checks the formatting consistently and contributors can run the same check locally.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- ci-cd, documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100