diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..3a4edf690ca5fd2213e31a83ede1503d5c73ccfa
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.project
diff --git a/readme.rst b/README.rst
similarity index 100%
rename from readme.rst
rename to README.rst
diff --git a/documentation/source/conf.py b/conf.py
similarity index 100%
rename from documentation/source/conf.py
rename to conf.py
diff --git a/documentation/source/definitions.rst b/definitions.rst
similarity index 100%
rename from documentation/source/definitions.rst
rename to definitions.rst
diff --git a/documentation/source/term/.gitkeep b/documentation/source/term/.gitkeep
deleted file mode 100644
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000
diff --git a/documentation/source/index.rst b/index.rst
similarity index 100%
rename from documentation/source/index.rst
rename to index.rst
diff --git a/documentation/.gitkeep b/overview/.gitkeep
similarity index 100%
rename from documentation/.gitkeep
rename to overview/.gitkeep
diff --git a/documentation/source/overview/Readme.rst b/overview/README.rst
similarity index 83%
rename from documentation/source/overview/Readme.rst
rename to overview/README.rst
index 0209925d7822918304b40030e5e66d205db9b244..b9466f43c49bed689c9e30f4ee567f29d1f7e22a 100644
--- a/documentation/source/overview/Readme.rst
+++ b/overview/README.rst
@@ -1,7 +1,7 @@
.. include:: ../definitions.rst
|main_project_name| Overview
-###########################
+###############################
.. toctree::
:maxdepth: 2
diff --git a/documentation/source/overview/about-openharmony.rst b/overview/about-openharmony.rst
similarity index 98%
rename from documentation/source/overview/about-openharmony.rst
rename to overview/about-openharmony.rst
index 943854ca5752743c6957d9f1be10b9a6af46b67c..2e3da69d81f5f942f0a0b94c2df73900803d1eef 100644
--- a/documentation/source/overview/about-openharmony.rst
+++ b/overview/about-openharmony.rst
@@ -2,7 +2,7 @@
.. include:: ../definitions.rst
About |main_project_name|
-=====================
+==========================
System Positioning
---------------------------
@@ -26,13 +26,15 @@ Technical Architecture
|main_project_name| is designed with a layered architecture, which from bottom to top consists of the kernel layer, system service layer, framework layer, and application layer. System functions are expanded by levels, from system to subsystem, and further to function/module. In multi-device deployment scenario, unnecessary subsystems, functions, or modules can be excluded from the system as required. The following shows the technical architecture of |main_project_name|.
+**Figure 1 Technical Architecture**
+
.. figure:: figures/architecture.png
:scale: 50
- width: 100 px
+ :width: 100 px
:align: center
- Figure 1 Technical Architecture
+
Kernel Layer
------------------
diff --git a/documentation/source/overview/.gitkeep b/overview/figures/.gitkeep
similarity index 100%
rename from documentation/source/overview/.gitkeep
rename to overview/figures/.gitkeep
diff --git a/documentation/source/overview/figures/architecture.png b/overview/figures/architecture.png
similarity index 100%
rename from documentation/source/overview/figures/architecture.png
rename to overview/figures/architecture.png
diff --git a/documentation/source/overview/figures/data_management.png b/overview/figures/data_management.png
similarity index 100%
rename from documentation/source/overview/figures/data_management.png
rename to overview/figures/data_management.png
diff --git a/documentation/source/overview/figures/device_virtual.png b/overview/figures/device_virtual.png
similarity index 100%
rename from documentation/source/overview/figures/device_virtual.png
rename to overview/figures/device_virtual.png
diff --git a/documentation/source/overview/figures/muti-device.png b/overview/figures/muti-device.png
similarity index 100%
rename from documentation/source/overview/figures/muti-device.png
rename to overview/figures/muti-device.png
diff --git a/documentation/source/overview/figures/system_security.jpg b/overview/figures/system_security.jpg
similarity index 100%
rename from documentation/source/overview/figures/system_security.jpg
rename to overview/figures/system_security.jpg
diff --git a/documentation/source/overview/figures/task_scheduling.png b/overview/figures/task_scheduling.png
similarity index 100%
rename from documentation/source/overview/figures/task_scheduling.png
rename to overview/figures/task_scheduling.png
diff --git a/documentation/source/overview/figures/virtual_bus.png b/overview/figures/virtual_bus.png
similarity index 100%
rename from documentation/source/overview/figures/virtual_bus.png
rename to overview/figures/virtual_bus.png
diff --git a/documentation/source/overview/system-security.rst b/overview/system-security.rst
similarity index 100%
rename from documentation/source/overview/system-security.rst
rename to overview/system-security.rst
diff --git a/documentation/source/overview/technical-features.rst b/overview/technical-features.rst
similarity index 100%
rename from documentation/source/overview/technical-features.rst
rename to overview/technical-features.rst
diff --git a/documentation/source/overview/figures/.gitkeep b/quick-start/.gitkeep
similarity index 100%
rename from documentation/source/overview/figures/.gitkeep
rename to quick-start/.gitkeep
diff --git a/documentation/source/quick-start/build-open-harmony.rst b/quick-start/build-open-harmony.rst
similarity index 98%
rename from documentation/source/quick-start/build-open-harmony.rst
rename to quick-start/build-open-harmony.rst
index c685187adc77d608cee6241cd180ca28ee2d5712..6c2c1917482d6da50e6054c4bedd91c45e8c1614 100644
--- a/documentation/source/quick-start/build-open-harmony.rst
+++ b/quick-start/build-open-harmony.rst
@@ -260,14 +260,8 @@ OHOS FreeRTOS flavour is based on `freertos` distribution and supports the follo
**Supported images:**
-.. list-table:: Supported machines
- :widths: auto
- :header-rows: 1
-
- * - Machine Name
- - Details
- * - freertos-demo
- - Emulator
+* freertos-demo
+
**Supported machines:**
diff --git a/documentation/source/quick-start/images/.gitkeep b/quick-start/images/.gitkeep
similarity index 100%
rename from documentation/source/quick-start/images/.gitkeep
rename to quick-start/images/.gitkeep
diff --git a/documentation/source/quick-start/images/architecture.png b/quick-start/images/architecture.png
similarity index 100%
rename from documentation/source/quick-start/images/architecture.png
rename to quick-start/images/architecture.png
diff --git a/documentation/source/readme/C++ Coding Style Guide.rst b/readme/C++ Coding Style Guide.rst
similarity index 99%
rename from documentation/source/readme/C++ Coding Style Guide.rst
rename to readme/C++ Coding Style Guide.rst
index c62dada198f48d29e3ff65def73b5e27d4f36c12..8e714784b27b4d64e4e83624e754c46863471430 100644
--- a/documentation/source/readme/C++ Coding Style Guide.rst
+++ b/readme/C++ Coding Style Guide.rst
@@ -170,8 +170,9 @@ For namespace naming, UpperCamelCase is recommended.
}
}
+
Recommendation 2.4.1 Do not abuse typedef or #define to alias basic types.
---------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------------------------
Unless otherwise specified, do not use typedef or #define to redefine a
basic value type. The basic types found in the ``<cstdint>`` header file
@@ -209,7 +210,7 @@ variables, function parameters, local variables, and member variables.
std::string path; // Good: When there is only one word, lowerCamelCase (all lowercase) is used.
Rule 2.5.1 Add the prefix ‘g\_’ to global variables. Do not add a prefix to a static variable.
-----------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------
Global variables should be used as little as possible, and special
attention should be paid to the use of global variables. This prefix
@@ -230,7 +231,7 @@ common member variables of classes are named in the same way.
}
Rule 2.5.2 Name member variables in classes based on the three styles of the lowerCamelCase and maintain a uniform coding style for a product or project.
-------------------------------------------------------------------------------------------------------------------------------------------------
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
.. code:: cpp
@@ -244,7 +245,7 @@ a member variable of the struct or union type. Keep the naming style
consistent with that for a local variable.
Macro, Constant, and Enumeration Names
---------------------------------------
+-----------------------------------------------------------
For macros and enumerated values, use all caps separated with
underscores (``_``). In the global scope, constants of named and unnamed
@@ -275,13 +276,13 @@ member variables use the lowerCamelCase naming style.
}
Formatting
-**********
+*************
Line Length
===========
Recommendation 3.1.1 Each line of code should contain a maximum of 120 characters.
-----------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------------------------------------
\*\* Note: \**It is recommended that the number of characters in each
line not exceed 120. It is recommended that the number of characters in
@@ -2578,8 +2579,8 @@ Rule 9.3.1 If type casting is required, use the type casting provided by the C++
**Note**:
-The type casting provided by C++ is more targeted, easy to read, and more secure than the C style. C++ provides the following types of
-casting:
+The type casting provided by C++ is more targeted, easy to read, and more secure than the C style. C++ provides the following types of casting:
+
* Type casting:
* ``dynamic_cast``: Used to inherit the downstream transformation of the system. ``dynamic_cast`` has the type
check function. Design the base class and derived class to avoid using dynamic_cast for casting.
@@ -2587,8 +2588,7 @@ casting:
into a base class pointer or reference.
This casting is often used to eliminate type ambiguity brought on by multiple inheritance, which is relatively safe. If it is a pure arithmetic
conversion, use the braces as stated in the following text.
- * ``reinterpret_cast``: Used to convert irrelevant types. ``reinterpret_cast`` forces the compiler to reinterpret the memory of a
-certain type of objects into another type, which is an unsafe conversion. It is recommended that ``reinterpret_cast`` be used as little as possible.
+ * ``reinterpret_cast``: Used to convert irrelevant types. ``reinterpret_cast`` forces the compiler to reinterpret the memory of a certain type of objects into another type, which is an unsafe conversion. It is recommended that ``reinterpret_cast`` be used as little as possible.
* ``const_cast``: Used to remove the ``const`` attribute of an object so that the object can be modified. You are advised to use ``const_cast`` as
little as possible.
@@ -2938,10 +2938,7 @@ Recommendation 9.7.1 If the function does not throw an exception, the declaratio
**Reasons:**
* If the function does not throw an exception, the declaration is ``noexcept``, which enables the compiler to optimize thefunction to the maximum extent, for example, reducing the execution paths and improving the efficiency of exiting when an error occurs.
-* For STL containers such as ``vector``, to ensure the interface robustness, if the ``move`` constructor of saved items is not declared as ``noexcept``, the ``copy machanism`` instead of the ``move machanism`` is used when the items are removed from the container. This would cause
- performance loss risks. If the function does not throw an exception, or a program does not intercept and process an
- exception thrown by the function, new ``noexcept`` keywords can be used to modify the function, indicating that the function does not throw an
- exception or the thrown exception is not intercepted or processed. For example:
+* For STL containers such as ``vector``, to ensure the interface robustness, if the ``move`` constructor of saved items is not declared as ``noexcept``, the ``copy machanism`` instead of the ``move machanism`` is used when the items are removed from the container. This would cause performance loss risks. If the function does not throw an exception, or a program does not intercept and process an exception thrown by the function, new ``noexcept`` keywords can be used to modify the function, indicating that the function does not throw an exception or the thrown exception is not intercepted or processed. For example:
.. code:: cpp
diff --git a/documentation/source/readme/Code of Conduct.rst b/readme/Code of Conduct.rst
similarity index 100%
rename from documentation/source/readme/Code of Conduct.rst
rename to readme/Code of Conduct.rst
diff --git a/documentation/source/readme/Communication in Community.rst b/readme/Communication in Community.rst
similarity index 57%
rename from documentation/source/readme/Communication in Community.rst
rename to readme/Communication in Community.rst
index acdd1fcee7ed4328547e03ba203557ca7c581f74..f9c55fdde23dae5ec6e3add6fb935faa7d6f40b6 100644
--- a/documentation/source/readme/Communication in Community.rst
+++ b/readme/Communication in Community.rst
@@ -16,13 +16,3 @@ If you have never subscribed to a mail list before, follow the steps below:
#. Enter your email address and click **Subscribe**. You will receive an email asking you to confirm the subscription.
#. Reply the email to confirm your subscription.
#. At last, you will receive a welcome email from the email list.
-
-
-.. table:: Email List
- :align: center
-======================= ============================= ================================================================================================
-Email Address Introduction Description
-======================= ============================= ================================================================================================
-|contact_info| Public Mailbox Public mailbox of the OpenHarmony community.
-
-======================= ============================= ================================================================================================
diff --git a/documentation/source/readme/Contributing to the Code.rst b/readme/Contributing to the Code.rst
similarity index 100%
rename from documentation/source/readme/Contributing to the Code.rst
rename to readme/Contributing to the Code.rst
diff --git a/documentation/source/readme/Contributing to the Documentation.rst b/readme/Contributing to the Documentation.rst
similarity index 97%
rename from documentation/source/readme/Contributing to the Documentation.rst
rename to readme/Contributing to the Documentation.rst
index 9d67aadb4921eedd1fa2c5957cb504a104762226..7f24cd218b2c0f64c77e785606d2e64568784596 100644
--- a/documentation/source/readme/Contributing to the Documentation.rst
+++ b/readme/Contributing to the Documentation.rst
@@ -62,4 +62,3 @@ You are encouraged to summarize experience and create technical content during l
* Tutorial: Title (Task Name)
* Title (Briefly Describe the Key Information of the Issue.)
-The writing templates are archived in the **contribute folder** in the Docs repository.
diff --git a/documentation/source/readme/Contribution Process.rst b/readme/Contribution Process.rst
similarity index 95%
rename from documentation/source/readme/Contribution Process.rst
rename to readme/Contribution Process.rst
index 9e0f7e9f73c2e55be1b6f564bfef3aaf316c3252..fa1272b5c8ee2c5479b825be6f57734e3be2e986 100644
--- a/documentation/source/readme/Contribution Process.rst
+++ b/readme/Contribution Process.rst
@@ -147,9 +147,9 @@ Access the fork repository on Gitlab, click the button for creating a PR, and se
For details, visit https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/#how-it-works
-.. note::
+.. Note::
-How do I create PRs at the same time if multiple code repositories have compilation dependencies? During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitlab uses issues as the dependency identifiers for code repositories with compilation dependencies to commit the PRs.
+ How do I create PRs at the same time if multiple code repositories have compilation dependencies? During the development of the operating system (OS), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitlab uses issues as the dependency identifiers for code repositories with compilation dependencies to commit the PRs.
Follow the operations below:
diff --git a/documentation/source/readme/FAQs.rst b/readme/FAQs.rst
similarity index 100%
rename from documentation/source/readme/FAQs.rst
rename to readme/FAQs.rst
diff --git a/documentation/source/readme/JavaScript Coding Style Guide.rst b/readme/JavaScript Coding Style Guide.rst
similarity index 100%
rename from documentation/source/readme/JavaScript Coding Style Guide.rst
rename to readme/JavaScript Coding Style Guide.rst
diff --git a/documentation/source/readme/Readme.rst b/readme/README.rst
similarity index 100%
rename from documentation/source/readme/Readme.rst
rename to readme/README.rst
diff --git a/documentation/source/quick-start/.gitkeep b/readme/images/.gitkeep
similarity index 100%
rename from documentation/source/quick-start/.gitkeep
rename to readme/images/.gitkeep
diff --git a/documentation/source/readme/images/Font_style.PNG b/readme/images/Font_style.PNG
similarity index 100%
rename from documentation/source/readme/images/Font_style.PNG
rename to readme/images/Font_style.PNG
diff --git a/documentation/source/readme/images/List-table.PNG b/readme/images/List-table.PNG
similarity index 100%
rename from documentation/source/readme/images/List-table.PNG
rename to readme/images/List-table.PNG
diff --git a/documentation/source/readme/images/List.PNG b/readme/images/List.PNG
similarity index 100%
rename from documentation/source/readme/images/List.PNG
rename to readme/images/List.PNG
diff --git a/documentation/source/readme/images/csv_table.PNG b/readme/images/csv_table.PNG
similarity index 100%
rename from documentation/source/readme/images/csv_table.PNG
rename to readme/images/csv_table.PNG
diff --git a/documentation/source/readme/images/math.PNG b/readme/images/math.PNG
similarity index 100%
rename from documentation/source/readme/images/math.PNG
rename to readme/images/math.PNG
diff --git a/documentation/source/readme/images/multi-column_list.PNG b/readme/images/multi-column_list.PNG
similarity index 100%
rename from documentation/source/readme/images/multi-column_list.PNG
rename to readme/images/multi-column_list.PNG
diff --git a/documentation/source/readme/images/multi_data.PNG b/readme/images/multi_data.PNG
similarity index 100%
rename from documentation/source/readme/images/multi_data.PNG
rename to readme/images/multi_data.PNG
diff --git a/documentation/source/readme/images/quick-start.PNG b/readme/images/quick-start.PNG
similarity index 100%
rename from documentation/source/readme/images/quick-start.PNG
rename to readme/images/quick-start.PNG
diff --git a/documentation/source/readme/images/tables.PNG b/readme/images/tables.PNG
similarity index 100%
rename from documentation/source/readme/images/tables.PNG
rename to readme/images/tables.PNG
diff --git a/documentation/source/readme/images/toctree.PNG b/readme/images/toctree.PNG
similarity index 100%
rename from documentation/source/readme/images/toctree.PNG
rename to readme/images/toctree.PNG
diff --git a/documentation/source/readme/reStructuredText Basics.rst b/readme/reStructuredText Basics.rst
similarity index 100%
rename from documentation/source/readme/reStructuredText Basics.rst
rename to readme/reStructuredText Basics.rst
diff --git a/documentation/source/readthedocs.yml b/readthedocs.yml
similarity index 100%
rename from documentation/source/readthedocs.yml
rename to readthedocs.yml
diff --git a/documentation/source/requirements.txt b/requirements.txt
similarity index 100%
rename from documentation/source/requirements.txt
rename to requirements.txt
diff --git a/documentation/source/supported-boards/96b-Avenger.rst b/supported-boards/96b-Avenger.rst
similarity index 100%
rename from documentation/source/supported-boards/96b-Avenger.rst
rename to supported-boards/96b-Avenger.rst
diff --git a/documentation/source/supported-boards/96b-nitrogen.rst b/supported-boards/96b-nitrogen.rst
similarity index 100%
rename from documentation/source/supported-boards/96b-nitrogen.rst
rename to supported-boards/96b-nitrogen.rst
diff --git a/documentation/source/supported-boards/Readme.rst b/supported-boards/README.rst
similarity index 100%
rename from documentation/source/supported-boards/Readme.rst
rename to supported-boards/README.rst
diff --git a/documentation/source/supported-boards/seco-imx8mm-c61.rst b/supported-boards/seco-imx8mm-c61.rst
similarity index 100%
rename from documentation/source/supported-boards/seco-imx8mm-c61.rst
rename to supported-boards/seco-imx8mm-c61.rst
diff --git a/documentation/source/supported-boards/seco-intel-b68.rst b/supported-boards/seco-intel-b68.rst
similarity index 99%
rename from documentation/source/supported-boards/seco-intel-b68.rst
rename to supported-boards/seco-intel-b68.rst
index 6959a0d76f44d835537836f94b403bd5d8d2f4a0..0e38a5a132d637b53415a99ec0953cd50d763eca 100644
--- a/documentation/source/supported-boards/seco-intel-b68.rst
+++ b/supported-boards/seco-intel-b68.rst
@@ -57,7 +57,7 @@ To generate images for SSD Disk, refer to the following flashing OHOS image sect
Flashing OHOS image
*******************
-.. _linux-image-1:
+.. _linux-image-2:
Linux image
===========
diff --git a/documentation/source/readme/images/.gitkeep b/term/.gitkeep
similarity index 100%
rename from documentation/source/readme/images/.gitkeep
rename to term/.gitkeep
diff --git a/documentation/source/term/glossary.rst b/term/glossary.rst
similarity index 100%
rename from documentation/source/term/glossary.rst
rename to term/glossary.rst