triz-docs by othmane

Go to file

Othmane Ataallah 84be05d6bf Some checks are pending Deploy triz-docs to 150 / build-and-deploy (push) Waiting to run Details feat: search		2026-04-29 14:30:42 +01:00
.gitea/workflows	chore: update README.md and deploy.yml	2026-04-29 13:21:21 +01:00
docs	add dead-pc-recovery	2026-04-29 13:11:22 +01:00
src	feat: search	2026-04-29 14:30:42 +01:00
static	intial push	2026-04-28 09:45:44 +01:00
.gitignore	cicd work	2026-04-28 10:26:40 +01:00
docusaurus.config.js	feat: search	2026-04-29 14:30:42 +01:00
package-lock.json	feat: search	2026-04-29 14:30:42 +01:00
package.json	feat: search	2026-04-29 14:30:42 +01:00
README.md	chore: update README.md and deploy.yml	2026-04-29 13:21:21 +01:00
sidebars.js	v0.1	2026-04-27 11:04:04 +01:00

README.md

TrizTech Engineering Documentation

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.

🚀 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 (Static Site Generator)
Framework: React
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:

🚀 Getting Started: Environment setup guides for TrizStock and related projects.
🔄 Workflow & Processes: Standard operating procedures for task management and branching.
🐙 Git Operations: Tool-specific guides for Git (Apache NetBeans, JetBrains IDEs, and Command-Line).
🗄️ Database Operations: SQL Server management, backup/restore protocols, and emergency data recovery.

💻 Local Development

Prerequisites

Node.js (LTS recommended)
npm

Installation

npm install

Run Locally

npm run start

The site will be available at http://localhost:3000.

Build for Production

npm run build

🎨 Design System

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.