Skip to main content

DOCUMENTATION / ENGINEERING NOTES

Build on what we've learned

Explore architecture decisions, integration guides, and debugging notes drawn from the project's engineering work.

Guide content is currently available in Chinese.

15 guides
Skills

Reusable Codex Skills: Local Iteration and GitHub Sync

Manage shared skills with a dedicated Git repository and user-level symlinks, covering discovery, local edits, multi-machine sync, and project-specific conventions.

AI Coding / Codex
Web Storage / RPC

Web Storage and Cross-Origin SSO: From Safari Differences to Client RPC

Explain how Cookie tokens or server sessions remove same-site SSO's dependence on shared iframe storage. Compare shared Domain cookies with API host-only HttpOnly cookies, including authentication changes, credentialed requests, and cross-site limits.

Frontend / React
Nginx

Enabling HTTPS across the site with Nginx

Unify public domains on 443 SSL with 80→301 redirects, keep internal domains on 80, and use certbot certonly to issue certificates before rolling out config.

Backend / Nginx
React

Embedding React into non-React pages

Mount a customer-service widget into non-React sites using createRoot and useEffect, and understand how HTML fragments are generated and injected.

Frontend / React
SMTP / IMAP

Complete Tencent Exmail configuration guide

Check administrator and member permissions, create client passwords, connect mail clients and Java applications, and diagnose 535 authentication errors.

Backend / Mail
Nginx

Next.js 15 four-site static launch

Build one archive locally, switch releases on the server with a single command, plus verification and pitfalls.

Backend / Nginx
Maven

Sparrow Parent and BOM

Separate build baselines, component versions, and application adoption, with complete POM examples.

Backend / Java
OpenAPI

Integrating springdoc-openapi

Understand Servlet MVC and WebFlux stacks and select the matching API documentation dependency.

Backend / Java
OpenAPI

OpenAPI grouping strategies

Resolve configuration conflicts across starters and create separate API groups for File and Passport.

Backend / Java
Maven

Maven sources and breakpoint debugging

Trace misplaced breakpoints to source packages and bytecode line tables, from publishing to local debugging.

Backend / Java
Netty

Netty inbound messages and OOM

Follow a handler case study to find unreleased references, memory leaks, and heartbeat failures.

Backend / Java
Netty

Netty memory sharing and release

Explore reference counting, zero-copy sharing, and deep copies to clarify memory ownership in message forwarding.

Backend / Java
Thymeleaf

Thymeleaf template paths

Diagnose missing templates caused by double slashes when a prefix meets a view name.

Backend / Java
React

The useCaptcha React Hook

Walk through session setup, image loading, and refresh behavior, including cleanup and retry boundaries.

Frontend / React
Next.js

Internationalization with next-intl

Connect locale routing, middleware, and message context, with guidance on grouped translations and troubleshooting.

Frontend / React