Merge pull request #273 from yel-hadd/master

docs: update README.md

Author: yel-hadd

README.md

@@ -1,38 +1,80 @@
-# tuxcare-documentation
+# TuxCare Documentation
 
+VuePress-based documentation site for TuxCare products and services.
 
-## Install dependencies
+## Tech Stack
 
-```
-$ yarn
+- VuePress 2.0.0-beta.61
+- Vue 3 + TypeScript
+- Vite bundler
+- Custom Vue components
+
+## Prerequisites
+
+- Node.js 22.x
+- Yarn (required)
+
+**⚠️ Important**: This project uses Yarn. Please do not use npm to avoid conflicts with the GitHub Actions deployment workflow.
+
+## Quick Start
+
+```bash
+# Install dependencies
+yarn install
+
+# Start development server
+yarn docs:dev
+
+# Visit http://localhost:8080
 ```
 
-## Start local server
+## Available Scripts
+
+| Command | Description |
+|---------|-------------|
+| `yarn docs:dev` | Start VuePress dev server with hot reload |
+| `yarn docs:build` | Build static site for production |
+| `yarn dev` | Start Vite dev server |
+| `yarn build` | Build with TypeScript compilation |
+| `yarn preview` | Preview production build locally |
+
+## Project Structure
 
-```sh
-$ yarn docs:dev
 ```
+docs/
+├── .vuepress/           # VuePress config and components
+├── els-for-os/          # Extended Lifecycle Support for OS
+├── els-for-runtimes-and-libraries/  # ELS for languages/frameworks
+├── els-for-applications/  # ELS for applications
+├── enterprise-support-for-almalinux/
+├── eportal/             # Enterprise portal docs
+└── ...
+```
+
+## Troubleshooting
 
-For some environments there could be an error:
+### OpenSSL Error (Legacy Node.js)
+
+If you encounter an OpenSSL initialization error:
 
 ```
-opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],
-library: 'digital envelope routines',
-reason: 'unsupported',
-code: 'ERR_OSSL_EVP_UNSUPPORTED'
+ERR_OSSL_EVP_UNSUPPORTED
 ```
 
-For workaround you can use
+Set the legacy OpenSSL provider before running dev server:
 
-```sh
-$ export NODE_OPTIONS=--openssl-legacy-provider
+```bash
+export NODE_OPTIONS=--openssl-legacy-provider
+yarn docs:dev
 ```
 
-before starting dev server.
+## Deployment
 
+The site automatically deploys to GitHub Pages when changes are pushed to the `master` branch. The GitHub Actions workflow:
 
-## Static assets
+1. Installs dependencies with `yarn install --frozen-lockfile`
+2. Builds the site with `yarn docs:build`
+3. Deploys to the `gh-pages` branch
+
+See `.github/workflows/deploy.yml` for the complete CI/CD configuration.
 
-```sh
-$ yarn docs:build
-```