Integrate TiDB Cloud API docs into TiDB Cloud docs

[ran-huang]

This issue tracks the efforts that integrate TiDB Cloud API docs into TiDB Cloud docs.

Background

1. Currently, the TiDB Cloud API docs is a page separate from TiDB Cloud docs. When a user visits the API docs, they feel they jump to a totally different site.

TiDB Cloud docs:

API docs:

2. The current API docs use the default Redoc theming, which is quite different from the style of our docs site.

Therefore, we need to integrate TiDB Cloud API docs into TiDB Cloud docs and provide consistent, seamless experience for API users.

Tasks

To achieve the goal, we need to do (at least) the following:

1. Embed the API docs into the current Cloud docs.
   • Users will see the same navigation bar and panels on the top and the left side. They won't feel they are taken to another site when they visit the API docs.
   • Estimated workload:
     • 1 week (FE)
     • 1 week (doc)
2. Tune the API docs theme to make it more consistent with the Cloud docs style.
   • Estimated workload:
     • 1 month (FE + UI)
     • 1 week (doc)
   • Note: some theming configuration might require subscription of Redocly basic or professional plans. We don't know yet.

Status

After consulting the FE engineer, we reach the following agreement: this feature is nice to have , but we don't have enough resources to invest in it right now. There are two major reasons:

• The front end resources are tight. The FE engineer is working on other features with higher priority and cannot start developing this feature within the next few months.
• We don't have budget for Redocly subscirption.