62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# 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](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
|
|
npm install
|
|
```
|
|
|
|
### Run Locally
|
|
```bash
|
|
npm run start
|
|
```
|
|
The site will be available at [http://localhost:3000](http://localhost:3000).
|
|
|
|
### Build for Production
|
|
```bash
|
|
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.
|
|
|
|
---
|
|
|
|
© 2026 TrizTech Engineering. All rights reserved.
|