pingcap / pingcap/website-docs

Further improve the style of TiDB Cloud API docs to make it consistent with that of the main doc site

Open
#495 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
23
Forks
33
Avg merge
3d 5h
Merged PRs (30d)
7

Description

This issue has no description.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; start by locating the TiDB Cloud API documentation and comparing it with the main doc site's style. Done means the API docs follow the main site's style consistently, but the empty description leaves the exact changes unspecified.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.