Merge branch 'cleanup/docs-readme-polish' into 'master'

docs: fix typos and Markdown formatting across project docs

Closes #714

See merge request postgres-ai/database-lab!1149

Author: agneum

CODE_OF_CONDUCT.md

@@ -114,7 +114,7 @@ the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], 
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.1, available at [v2.1].
 
 Community Impact Guidelines were inspired by [Mozilla CoC].

CONTRIBUTING.md

@@ -133,7 +133,7 @@ Consistent messaging is important throughout the codebase. Follow these guidelin
 
 #### CLI output
 - Use concise, action-oriented language
-- Present tense with ellipsis for in-progress actions: `Creating clone...` 
+- Present tense with ellipsis for in-progress actions: `Creating clone...`
   - Ellipsis (`...`) indicates an ongoing process where the user should wait
   - Always follow up with a completion message when the operation finishes
 - Past tense with period for results: `Clone created successfully.`
@@ -166,7 +166,7 @@ Documentation for Database Lab Engine and additional components is hosted at htt
 We're building documentation following the principles described at https://documentation.divio.com/:
 
 > There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four.
-> 
+>
 > They are: tutorials, how-to guides, technical reference and explanation. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most documentation - often immensely.
 
 Learn more: https://documentation.divio.com/.
@@ -194,7 +194,7 @@ Postman collection is generated based on the OpenAPI spec file, using [Portman](
 ##### Setup and Generation
 1. Install Portman: `npm install -g @apideck/portman`
 2. Generate Postman collection file:
-   ```
+   ```bash
    portman --cliOptionsFile engine/api/postman/portman-cli.json
    ```
 
@@ -207,7 +207,7 @@ Postman collection is generated based on the OpenAPI spec file, using [Portman](
 
 ##### CI/CD Integration
 The Postman collection is automatically run in CI/CD pipelines using Newman. For local testing:
-```
+```bash
 newman run engine/api/postman/dblab_api.postman_collection.json -e engine/api/postman/branching.aws.postgres.ai.postman_environment.json
 ```
 

README.md

@@ -16,7 +16,7 @@
 <div align="center">
   <strong>⚡ Blazing-fast PostgreSQL cloning and branching 🐘</strong><br /><br />
   🛠️ Build powerful dev/test environments.<br />
-  🔃 Cover 100% of DB migrations with CI tests.<br>
+  🔃 Cover 100% of DB migrations with CI tests.<br />
   💡 Quickly verify ChatGPT ideas to get rid of hallucinations.<br /><br />
   Available for any PostgreSQL, including self-managed and managed services<sup>*</sup> like AWS RDS, GCP Cloud SQL, Supabase, and Timescale.<br /><br />
   It can be installed and used anywhere: across all cloud environments and on-premises.
@@ -204,15 +204,13 @@ Many thanks to our amazing contributors!
 </a>
 
 ## Translations
-Making DBLab more accessible to engineers around the globe is a great help for the project. Check details in the [translation section of contributing guide](./CONTRIBUTING.md#Translation).
+Making DBLab more accessible to engineers around the globe is a great help for the project. Check details in the [translation section of contributing guide](./CONTRIBUTING.md#translation).
 
 This README is available in the following translations:
 - [German / Deutsch](translations/README.german.md) (by [@ane4ka](https://github.com/ane4ka))
 - [Brazilian Portuguese / Português (BR)](translations/README.portuguese-br.md) (by [@Alexand](https://gitlab.com/Alexand))
-- [Russian / Pусский](translations/README.russian.md) (by [@Tanya301](https://github.com/Tanya301))
+- [Russian / Русский](translations/README.russian.md) (by [@Tanya301](https://github.com/Tanya301))
 - [Spanish / Español](translations/README.spanish.md) (by [@asotolongo](https://gitlab.com/asotolongo))
 - [Ukrainian / Українська](translations/README.ukrainian.md) (by [@denis-boost](https://github.com/denis-boost))
 
 👉 [How to make a translation contribution](./CONTRIBUTING.md#translation)
-
-

SECURITY.md

@@ -16,7 +16,7 @@ To report a security issue, please email us at security@postgres.ai with all the
 - Your issue is not security related.
 
 ## Security Vulnerability Response
-Each report is acknowledged and analyzed by the project's maintainers and the security team within 3 working days. 
+Each report is acknowledged and analyzed by the project's maintainers and the security team within 3 working days.
 
 The reporter will be kept updated at every stage of the issue's analysis and resolution (triage -> fix -> release).
 

engine/api/README.md

@@ -15,10 +15,10 @@ We use ReadMe.io to host the API documentation: https://dblab.readme.io/. Once a
 The Postman collection is generated from the OpenAPI spec file using [Portman](https://github.com/apideck-libraries/portman).
 1. Install and initialize `portman`.
 1. Generate a new version of the Postman collection:
-    ```
+    ```bash
     portman --cliOptionsFile engine/api/postman/portman-cli.json
     ```
 1. Review and adjust the collection:
     - Ensure object creation occurs before its deletion and pass the new object's ID between requests (TODO: provide example).
     - Review and update tests as needed (TODO: details).
-1. Commit, push, and ensure Newman's CI/CD testing passes.
+1. Commit, push, and ensure Newman's CI/CD testing passes.

ui/packages/platform/README.md

@@ -9,7 +9,7 @@ For detailed information about UI development, please refer to the main [CONTRIB
 ### Start Development Server
 Specify REST API server URL with `REACT_APP_API_SERVER` environment variable.
 
-```
+```bash
 npm install
 npm run build
 npm run start