Microtec Developer Documentation

Internal documentation site for Microtec — covering architecture guides, API references, solution designs, HR modules, and team processes.

Built with VitePress and deployed via Azure Pipelines.

---

What's Inside

Section	Description
Polaris Systems	HR Personnel Module — API reference, quality gate, agile ceremonies
Microtec	Company overview, teams, tools & frameworks
Architecture	Saga patterns, authorization tokens, data transfer
Solution Docs	Solution designs, sales/purchase invoices, ZATCA flow
POS	Point of sale app — architecture, state management, hardware integration
ERP	ERP technical overview, business logic, code specifications
Processes	Business process cycle, Kanban, Scrum, Definition of Done
Recruitment	Interview guides and scoring systems
Resources	FAQ, training, server deployment, shared packages

---

Getting Started

Requirements: Node.js 18+

# Install dependencies
npm install

# Start local dev server
npm run dev
# → http://localhost:5173

# Build for production
npm run build

# Preview production build
npm run preview

---

Project Structure

docs/
├── .vitepress/
│   ├── config.mts          # Site config, nav bar, sidebar generator
│   └── theme/
│       ├── index.ts         # Theme registration
│       ├── Layout.vue       # Custom layout
│       └── custom.css       # Microtec brand styles
├── Polaris-Systems/         # HR modules, agile ceremonies
├── Microtec/                # Company info
├── Solution-Documentation/  # Technical designs
├── Pos/                     # POS documentation
├── Erp/                     # ERP documentation
├── DataTransfer/            # Data transfer module
├── Recuritment/             # Hiring guides
└── ...                      # Other sections
azure-pipelines.yml          # CI/CD — builds and publishes on push to main

---

CI/CD

The azure-pipelines.yml pipeline triggers on every push to main:

1. Installs Node.js 20
2. Runs npm ci
3. Runs npm run build
4. Publishes the docs/.vitepress/dist folder as a build artifact named site

---

Contributing

1. Create a new branch from main
2. Add or update .md files inside docs/
3. The sidebar is auto-generated — no config changes needed for new pages
4. For new top-level nav items, update themeConfig.nav in docs/.vitepress/config.mts
5. Open a Pull Request targeting main