From 23ca95bc4c20b89395331effa2a88c5d0ac9d693 Mon Sep 17 00:00:00 2001 From: Othmane Ataallah <”othmane.ataallah.triztech@gmail.com”> Date: Wed, 29 Apr 2026 13:21:21 +0100 Subject: [PATCH] chore: update README.md and deploy.yml --- .gitea/workflows/deploy.yml | 4 +- README.md | 78 +++++++++++++++++++++++-------------- 2 files changed, 51 insertions(+), 31 deletions(-) diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml index 5b01c1a..5e326a8 100644 --- a/.gitea/workflows/deploy.yml +++ b/.gitea/workflows/deploy.yml @@ -1,4 +1,4 @@ -name: Deploy triz-docs to civital server +name: Deploy triz-docs to 150 on: push: @@ -6,7 +6,7 @@ on: jobs: build-and-deploy: - runs-on: serveurtest150 + runs-on: 150 env: GIT_REPO_URL: 145.239.66.197:3000/TrizTech/triz-docs.git diff --git a/README.md b/README.md index b28211a..cd2d296 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,61 @@ -# Website +# TrizTech Engineering Documentation -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +Welcome to the official TrizTech internal engineering documentation. This site is the single source of truth for our onboarding processes, development workflows, and technical standards. -## Installation +## πŸš€ Purpose +This repository hosts a high-performance, modern documentation portal built with Docusaurus. It is designed to empower our engineering team with: +- **Instant Onboarding**: Clear guides for setting up development environments. +- **Standardized Workflows**: Step-by-step instructions for our Git and task management processes. +- **Operational Excellence**: Critical guides for database management and emergency recovery. +- **Universal Search**: Fast, context-aware search across all technical resources. + +## πŸ›  Tech Stack + +- **Engine**: [Docusaurus 3](https://docusaurus.io/) (Static Site Generator) +- **Framework**: [React](https://reactjs.org/) +- **Theme**: Custom "Dark-First" Premium Theme (TrizTech Branding) +- **Syntax Highlighting**: Prism.js (Java, SQL, Bash, XML, Properties) +- **Icons**: Emoji-based category indexing + +## πŸ“‚ Documentation Structure + +The documentation is organized into four core pillars: + +1. **πŸš€ Getting Started**: Environment setup guides for TrizStock and related projects. +2. **πŸ”„ Workflow & Processes**: Standard operating procedures for task management and branching. +3. **πŸ™ Git Operations**: Tool-specific guides for Git (Apache NetBeans, JetBrains IDEs, and Command-Line). +4. **πŸ—„οΈ Database Operations**: SQL Server management, backup/restore protocols, and emergency data recovery. + +## πŸ’» Local Development + +### Prerequisites +- [Node.js](https://nodejs.org/) (LTS recommended) +- [npm](https://www.npmjs.com/) + +### Installation ```bash -yarn +npm install ``` -## Local Development - +### Run Locally ```bash -yarn start +npm run start +``` +The site will be available at [http://localhost:3000](http://localhost:3000). + +### Build for Production +```bash +npm run build ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +## 🎨 Design System -## Build +The site uses a custom-built design system defined in `src/css/custom.css`, featuring: +- **Glassmorphic UI**: Saturated blur effects on navigation and headers. +- **Indigo Palette**: A curated color system for both light and dark modes. +- **Premium Content Styling**: Centered images with rounded corners, shadows, and interactive hover states. -```bash -yarn build -``` +--- -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```bash -USE_SSH=true yarn deploy -``` - -Not using SSH: - -```bash -GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +Β© 2026 TrizTech Engineering. All rights reserved.