👋 Welcome

Welcome to Zaixi Wiki —— an online documentation site maintained by yunzaixi-dev.

About Documentation Sections

This site adopts "single ownership + priority judgment" to avoid duplication and overlap:

• Single ownership: Each document belongs to only one primary category; secondary topics are referenced via links in the body, not duplicated across directories.
• Judgment order (from high to low):
  1. Contains privacy/secrets/unpublished information → Private section
  2. Course/academic/exam related → University section
  3. Site/repository metadata, historical evolution, maintenance standards → History section
  4. Classify by "primary deployment location": browser/client → Frontend; server/business/API → Backend; CI/CD/delivery pipeline → DevOps; compute/storage/network/database/cloud/monitoring platform → Infrastructure
  5. Efficiency/process/habits weakly related to specific technical implementation → Workflow section
  6. Other publicly shareable general content → Public section
• Boundary rules: Runtime location takes precedence over language used; deployment/platform building goes to Infrastructure, delivery pipelines go to DevOps; privacy and academic considerations take precedence over technical domain.
• Storage requirements: Files must be located in the corresponding directory; update frontmatter/sidebar as needed.

History Section

• Scope: Records of this site's history, technical implementation, development logs, site owner information, etc.
• Exclusions: Specific technical content or study notes (classify by technical domain), private or unpublished materials (move to private), academic course content (move to university).

Frontend Section

• Scope: UI/interaction, browser or cross-platform frameworks (Svelte/SvelteKit), frontend engineering (Vite/Webpack frontend configuration), CSS/design systems, Web API and component libraries.
• Exclusions: Backend logic for server-side rendering, API design, database access, deployment/release processes (move to backend/infrastructure/DevOps).

Backend Section

• Scope: Business services and API design, BFF/GraphQL/REST, server-side languages and frameworks, domain modeling, data access layer implementation, authentication/session and other server-side capabilities.
• Exclusions: Database/message queue deployment and operations (move to infrastructure), CI/CD and release strategies (move to DevOps).

DevOps Section

• Scope: CI/CD pipelines, build/release/canary strategies, environment difference management, quality gates, SRE toolchain, team standards.
• Exclusions: Infrastructure-level cluster/network/storage construction (move to infrastructure), business feature coding (move to frontend/backend).

Infrastructure Section

• Scope: Compute/storage/network/operating systems, containers and orchestration (Kubernetes), databases and caching, message queues, monitoring/logging/alerting platforms, cloud service configuration.
• Exclusions: Pipeline scripts involving only delivery processes (move to DevOps), business-level data access code (move to backend).

Workflow Section

• Scope: Personal/team efficiency tools and processes, automation scripts, time management, note-taking/knowledge management methods, work habits decoupled from specific technical implementation.
• Exclusions: Any content primarily focused on technical implementation (move to corresponding technical classification), academic courses (move to university).

University Section

• Scope: Course notes, lab reports, academic reading, exam review, campus projects.
• Exclusions: Enterprise projects or production environment related content (classify by technical domain), materials containing privacy (move to private).

Public Section

• Scope: General knowledge without sensitive information and cross-domain, public speeches/reading excerpts, content understandable without specific technical context.

• Exclusions: Any materials containing unpublished information or requiring access control (move to private), technical implementation details (classify by technical domain).

• Scope: Contains personal privacy, secrets, accounts, internal materials, or unpublished plans.

• Note: If a topic fits multiple classifications, the private section remains the final destination.

Documentation Toolchain

About LaTeX

LaTeX is a document typesetting software system based on TeX. LaTeX provides a high-level, descriptive markup language that makes TeX easier to use: TeX handles document layout, while LaTeX handles document content processing. Since TeX's formatting commands are very basic, it provides authors with ready-made commands to meet formatting and layout requirements such as section titles, footnotes, cross-references, and bibliographies.

We use LaTeX to express mathematical formulas in the documentation site

About Markdown

Markdown is a lightweight markup language used to create formatted text through plain text editors. John Gruber created Markdown in 2004 with the goal of creating a markup language that is easy to read and write.

Markdown is widely used in blogs, instant messaging, and large language models, and is also commonly found in online forums, collaborative software, documentation pages, and README files.

We use Markdown to build the content of the documentation site

Version Control and CI/CD

About Git

Git is a fast, scalable distributed version control system with an exceptionally rich command set, providing both high-level operations and allowing complete access to its internal mechanisms.

We use Git for version management of the documentation site

About GitHub

GitHub is a proprietary developer platform that allows developers to create, store, manage, and share code. It uses Git to implement distributed version control, and GitHub itself provides access control, issue tracking, software feature requests, task management, continuous integration, and Wiki functionality for each project.

GitHub has been a subsidiary of Microsoft since 2018, with headquarters in San Francisco.

The documentation site's code is hosted in a GitHub private repository

About GitHub Actions

GitHub Actions is a workflow automation platform provided by GitHub for automating, customizing, and executing tasks in the software development process within code repositories (common uses include continuous integration and continuous deployment). It allows developers to create, discover, and reuse "actions" (reusable automation components) and combine multiple actions into configurable workflows to accomplish building, testing, publishing, and deployment tasks.

GitHub Actions uses an event-driven mechanism: workflows are typically defined in YAML files and can be triggered to run when specific events occur (such as code pushes, pull requests, scheduled tasks, or manual triggers). Workflows consist of one or more jobs that run in execution environments called "runners"; runners can be either GitHub-hosted environments or self-hosted by users.

GitHub released GitHub Actions to the public during the GitHub Universe event in 2018, positioning it as a capability for automation and workflow orchestration within repositories.

The documentation site executes building, deployment, and automatic translation on GitHub Actions

Frontend Toolchain

About V8

V8 is an open-source JavaScript and WebAssembly engine developed by Google, originally released with Google Chrome in 2008. It compiles JavaScript to machine code through optimization techniques such as just-in-time (JIT) compilation to improve execution performance; it is currently widely used in Chrome, Node.js, and other Chromium-based projects.

The runtime environment of the documentation site is V8

About Node.js

Node.js is a cross-platform JavaScript runtime environment based on V8, adopting an event-driven and non-blocking I/O model, commonly used for building network services and command-line tools. The project was originally released by Ryan Dahl in 2009 and has formed a large-scale third-party package ecosystem around npm.

The build and development environment of the documentation site is Node.js

About TypeScript

TypeScript is an open-source programming language led by Microsoft, a typed superset of JavaScript that compiles to JavaScript. It introduces static types, interfaces, and generics to improve the maintainability and tooling support (such as type checking and auto-completion) of large JavaScript projects.

The development language of the documentation site is TypeScript

About React

React is an open-source frontend UI library maintained by Facebook (now Meta), originally released in 2013. It centers on component-based and declarative rendering, typically combined with unidirectional data flow, Hooks, and other mechanisms to build reusable user interfaces.

The UI framework of the documentation site is React

About Yarn

Yarn is a package manager for JavaScript, released by Facebook and other teams in 2016 to improve the speed and reproducibility of dependency installation. It locks dependency resolution results through lockfiles (such as yarn.lock) and provides caching and parallel download mechanisms.

The package manager of the documentation site is Yarn

About Vite

Vite is a build tool and development server for modern frontend development, released by Evan You in 2020. Its development mode is based on native ESM on-demand loading, and the production build phase typically uses Rollup for bundling to achieve faster startup and hot update experience.

The build tool of the documentation site is Vite

About Rspack

Rspack is a frontend bundling tool targeting performance, with its core implemented in Rust and emphasizing compatibility with the Webpack ecosystem (configuration, loader and plugin interfaces, etc.). It was open-sourced in 2023 and is commonly used for build acceleration and incremental compilation in large projects.

The build tool of the documentation site is Rspack

About Docusaurus

Docusaurus is a static site generator open-sourced by Facebook (now Meta), primarily used for building documentation sites, originally released in 2017. It uses Markdown/MDX as the main content format and provides sidebar navigation, version management, multi-language, theming, and deployment capabilities, suitable for maintaining and publishing documentation as an engineering artifact.

The development framework of the documentation site is Docusaurus

Development Principles

Automation over manual work. Declarative over imperative. Immutable over mutable. Elasticity over fixed capacity. Observability is critical. Failure is the norm, not the exception. Fast recovery over failure avoidance. Decentralization over single points of dependency. Standards over customization. Platform capabilities over individual skills. Infrastructure should be managed like code. Environments should be consistent, not just barely working. Services should be independent, not entangled. Scaling should be horizontal, not vertical. Releases should be frequent and rollbackable. Security should be built-in, not an afterthought.