diff --git a/README.md b/README.md index 414e62b..a96a939 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ necessary for the compilation process, all the dependencies required for the correct work, as well as to get the latest version of **ONLYOFFICE products** source code and build all their components. -**Important!** We can only guarantee the correct work of the products built from -the `master` branch. +**Important!** We can only guarantee the correct work of the products built +from the `master` branch. ## How to use - Linux diff --git a/develop/README.md b/develop/README.md index 83e51d0..17860f0 100644 --- a/develop/README.md +++ b/develop/README.md @@ -7,7 +7,8 @@ but don't want to compile pretty compilcated core product to make those changes. ## System requirements **Note**: ARM-based architectures are currently **NOT** supported; -attempting to run the images on ARM devices may result in startup failures or other runtime issues. +attempting to run the images on ARM devices may result in startup failures +or other runtime issues. ### Windows diff --git a/scripts/sdkjs_common/jsdoc/README.md b/scripts/sdkjs_common/jsdoc/README.md index a0dd1ae..9432882 100644 --- a/scripts/sdkjs_common/jsdoc/README.md +++ b/scripts/sdkjs_common/jsdoc/README.md @@ -1,7 +1,7 @@ # Documentation Generation Guide -This guide explains how to generate documentation for Onlyoffice Builder and -Plugins (Methods/Events) API using the following Python scripts: +This guide explains how to generate documentation for Onlyoffice Builder +and Plugins (Methods/Events) API using the following Python scripts: - `office-api/generate_docs_json.py` - `office-api/generate_docs_md.py` @@ -38,8 +38,8 @@ This script generates JSON documentation based on the `apiBuilder.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the JSON documentation will be - saved. If not specified, the default path is + - `output_path` (optional): The directory where the JSON documentation + will be saved. If not specified, the default path is `../../../../office-js-api-declarations/office-js-api`. ### `office-api/generate_docs_md.py` @@ -53,8 +53,8 @@ This script generates Markdown documentation from the `apiBuilder.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the Markdown documentation will - be saved. If not specified, the default path is + - `output_path` (optional): The directory where the Markdown documentation + will be saved. If not specified, the default path is `../../../../office-js-api/`. ### `plugins/generate_docs_methods_json.py` @@ -68,8 +68,8 @@ This script generates JSON documentation based on the `api_plugins.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the JSON documentation will be - saved. If not specified, the default path is + - `output_path` (optional): The directory where the JSON documentation + will be saved. If not specified, the default path is `../../../../office-js-api-declarations/office-js-api-plugins`. ### `plugins/generate_docs_events_json.py` @@ -83,8 +83,8 @@ This script generates JSON documentation based on the `plugin-events.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the JSON documentation will be - saved. If not specified, the default path is + - `output_path` (optional): The directory where the JSON documentation + will be saved. If not specified, the default path is `../../../../office-js-api-declarations/office-js-api-plugins`. ### `plugins/generate_docs_methods_md.py` @@ -98,8 +98,8 @@ This script generates Markdown documentation from the `api_plugins.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the Markdown documentation will - be saved. If not specified, the default path is + - `output_path` (optional): The directory where the Markdown documentation + will be saved. If not specified, the default path is `../../../../office-js-api/`. ### `plugins/generate_docs_events_md.py` @@ -113,8 +113,8 @@ This script generates Markdown documentation from the `plugin-events.js` files. ``` - **Parameters**: - - `output_path` (optional): The directory where the Markdown documentation will - be saved. If not specified, the default path is + - `output_path` (optional): The directory where the Markdown documentation + will be saved. If not specified, the default path is `../../../../office-js-api/`. ## Example @@ -133,6 +133,6 @@ python generate_docs_md.py /path/to/save/markdown ## Notes -- Make sure to have all necessary permissions to run these scripts and write to - the specified directories. +- Make sure to have all necessary permissions to run these scripts and write + to the specified directories. - The output directories will be created if they do not exist. diff --git a/scripts/sdkjs_common/jsdoc/Readme.txt b/scripts/sdkjs_common/jsdoc/Readme.txt deleted file mode 100644 index e69de29..0000000