docs: create the docs folder and update repo metadata

CONTRIBUTING.md

@@ -0,0 +1 @@
+The development guide is located under the [docs](docs/README.md) folder.

README.md

@@ -36,6 +36,7 @@
 **OceanBase Database** is a distributed relational database. It is developed entirely by Ant Group. OceanBase Database is built on a common server cluster. Based on the [Paxos](https://lamport.azurewebsites.net/pubs/lamport-paxos.pdf) protocol and its distributed structure, OceanBase Database provides high availability and linear scalability. OceanBase Database is not dependent on specific hardware architectures.
 
 # Key features
+
 * **Transparent Scalability** : An OceanBase cluster can be scaled out to 1,500 nodes transparently, handling petabytes of data and a trillion rows of records.
 * **Ultra-fast Performance** : The only distributed database that has refreshed both TPC-C record, at 707 million tmpC, and TPC-H record, at 15.26 million QphH @30000GB.
 * **Real-time Operational Analytics** : A unified system for both transactional and real-time operational analytics workloads.
@@ -46,9 +47,11 @@
 See also [key features](https://en.oceanbase.com/product/opensource) for more details.
 
 # System architecture
+
 ![image.png](https://cdn.nlark.com/yuque/0/2022/png/25820454/1667369873624-c1707034-471a-4f79-980f-6d1760dac8eb.png)
 
 [Learn More](https://en.oceanbase.com/docs/community-observer-en-10000000000829641)
+
 # Quick start
 
 ## How to deploy
@@ -67,25 +70,31 @@ source ~/.oceanbase-all-in-one/bin/env.sh
 # quickly deploy OceanBase database
 obd demo
 ```
+
 ### 🐳 Deploy by docker
 
-1. Pull OceanBase image (optional)
-```shell
-docker pull oceanbase/oceanbase-ce
-```
-2. Start an OceanBase Database instance
-```shell
-# Deploy an instance with the maximum specifications supported by the container.
-docker run -p 2881:2881 --name obstandalone -e MINI_MODE=0 -d oceanbase/oceanbase-ce
-# Or deploy a mini standalone instance.
-docker run -p 2881:2881 --name obstandalone -e MINI_MODE=1 -d oceanbase/oceanbase-ce
-```
-3. Connect to the OceanBase Database instance
-```shell
-docker exec -it obstandalone ob-mysql sys # Connect to the root user of the sys tenant.
-docker exec -it obstandalone ob-mysql root # Connect to the root user of the test tenant.
-docker exec -it obstandalone ob-mysql test # Connect to the test user of the test tenant.
-```
+1. Pull OceanBase image (optional):
+
+    ```shell
+    docker pull oceanbase/oceanbase-ce
+    ```
+
+2. Start an OceanBase Database instance:
+
+    ```shell
+    # Deploy an instance with the maximum specifications supported by the container.
+    docker run -p 2881:2881 --name obstandalone -e MINI_MODE=0 -d oceanbase/oceanbase-ce
+    # Or deploy a mini standalone instance.
+    docker run -p 2881:2881 --name obstandalone -e MINI_MODE=1 -d oceanbase/oceanbase-ce
+    ```
+
+3. Connect to the OceanBase Database instance:
+
+    ```shell
+    docker exec -it obstandalone ob-mysql sys # Connect to the root user of the sys tenant.
+    docker exec -it obstandalone ob-mysql root # Connect to the root user of the test tenant.
+    docker exec -it obstandalone ob-mysql test # Connect to the test user of the test tenant.
+    ```
 
 See also [Quick experience](https://en.oceanbase.com/docs/community-observer-en-10000000000829647) or [Quick Start (Simplified Chinese)](https://www.oceanbase.com/docs/common-oceanbase-database-cn-10000000001692850) for more details.
 
@@ -95,8 +104,7 @@ See [OceanBase Developer Document](https://github.com/oceanbase/oceanbase/wiki/C
 
 # Roadmap
 
-For future plans, see [Roadmap 2023](https://github.com/oceanbase/oceanbase/issues/1364).  
-See also [OceanBase Roadmap](https://github.com/orgs/oceanbase/projects) for more details.
+For future plans, see [Roadmap 2023](https://github.com/oceanbase/oceanbase/issues/1364). See also [OceanBase Roadmap](https://github.com/orgs/oceanbase/projects) for more details.
 
 # Case study
 
@@ -106,7 +114,7 @@ See also [success stories](https://en.oceanbase.com/customer/home) and [Who is u
 
 # Contributing
 
-Contributions are highly appreciated. Read the [Contribute to OceanBase](https://github.com/oceanbase/oceanbase/wiki/Contribute-to-OceanBase) guide to getting started.
+Contributions are highly appreciated. Read the [development guide](docs/README.md) to getting started.
 
 # License
 
@@ -119,4 +127,4 @@ Join the OceanBase community via:
 * [Slack Workspace](https://join.slack.com/t/oceanbase/shared_invite/zt-1e25oz3ol-lJ6YNqPHaKwY_mhhioyEuw)
 * [Chinese User Forum](https://ask.oceanbase.com/)
 * DingTalk Group: 33254054 ([QR code](images/dingtalk.svg))
-* WeChat Group (Add the assistant with WeChat ID: OBCE666)
+* WeChat Group (Add the assistant with WeChat ID: OBCE666)

docs/README.md

@@ -0,0 +1,25 @@
+# OceanBase Development Guide
+
+## About this guide
+
+* **The target audience** of this guide is OceanBase contributors, both new and experienced.
+* **The objective** of this guide is to help contributors become an expert of OceanBase, who is familiar with its design and implementation and thus is able to use it fluently in the real world as well as develop OceanBase itself deeply.
+
+## The structure of this guide
+
+At present, the guide is composed of the following parts:
+
+1. **Get started**: Setting up the development environment, build and connect to the OceanBase server, the subsections are based on an imagined newbie user journey.
+    1. Install toolchain
+    2. Get the code, build and run
+    3. Set up an IDE
+    4. Write and run unit tests
+    5. Debug and profile
+    6. Commit code and submit a pull request
+2. **Contribute to OceanBase**: helps you quickly get involved in the OceanBase community, which illustrates what contributions you can make and how to quickly make one.
+
+## User documents
+
+This guide does _not_ contains user documents.
+
+For user documents, please refer to [oceanbase-doc](https://github.com/oceanbase/oceanbase-doc).