huanld
2fb067ecbf
checklocks / checklocks (push) Has been cancelled
CodeQL / Analyze (go) (push) Has been cancelled
natlab-integrationtest / natlab-integrationtest (push) Has been cancelled
CI / gomod-cache (push) Has been cancelled
CI / race-root-integration (1/4) (push) Has been cancelled
CI / race-root-integration (2/4) (push) Has been cancelled
CI / race-root-integration (3/4) (push) Has been cancelled
CI / race-root-integration (4/4) (push) Has been cancelled
CI / test (-race, amd64, 1/3) (push) Has been cancelled
CI / test (-race, amd64, 2/3) (push) Has been cancelled
CI / test (-race, amd64, 3/3) (push) Has been cancelled
CI / test (386) (push) Has been cancelled
CI / test (amd64) (push) Has been cancelled
CI / Windows (benchmarks) (push) Has been cancelled
CI / Windows (1/2) (push) Has been cancelled
CI / Windows (2/2) (push) Has been cancelled
CI / macos (push) Has been cancelled
CI / privileged (push) Has been cancelled
CI / vm (push) Has been cancelled
CI / cross (386, linux) (push) Has been cancelled
CI / cross (amd64, darwin) (push) Has been cancelled
CI / cross (amd64, freebsd) (push) Has been cancelled
CI / cross (amd64, openbsd) (push) Has been cancelled
CI / cross (amd64, windows) (push) Has been cancelled
CI / cross (arm, 5, linux) (push) Has been cancelled
CI / cross (arm, 7, linux) (push) Has been cancelled
CI / cross (arm64, darwin) (push) Has been cancelled
CI / cross (arm64, linux) (push) Has been cancelled
CI / cross (arm64, windows) (push) Has been cancelled
CI / cross (loong64, linux) (push) Has been cancelled
CI / ios (push) Has been cancelled
CI / crossmin (amd64, illumos) (push) Has been cancelled
CI / crossmin (amd64, plan9) (push) Has been cancelled
CI / crossmin (amd64, solaris) (push) Has been cancelled
CI / crossmin (ppc64, aix) (push) Has been cancelled
CI / android (push) Has been cancelled
CI / wasm (push) Has been cancelled
CI / tailscale_go (push) Has been cancelled
CI / fuzz (push) Has been cancelled
CI / depaware (push) Has been cancelled
CI / go_generate (push) Has been cancelled
CI / make_tidy (push) Has been cancelled
CI / licenses (push) Has been cancelled
CI / staticcheck (macOS) (push) Has been cancelled
CI / staticcheck (Linux) (push) Has been cancelled
CI / staticcheck (Windows) (push) Has been cancelled
CI / staticcheck (Portable (1/4)) (push) Has been cancelled
CI / staticcheck (Portable (2/4)) (push) Has been cancelled
CI / staticcheck (Portable (3/4)) (push) Has been cancelled
CI / staticcheck (Portable (4/4)) (push) Has been cancelled
CI / notify_slack (push) Has been cancelled
CI / merge_blocker (push) Has been cancelled
CI / check_mergeability_strict (push) Has been cancelled
CI / check_mergeability (push) Has been cancelled
Dockerfile build / deploy (push) Has been cancelled
test installer.sh / test (curl, alpine:3.21) (push) Has been cancelled
test installer.sh / test (curl, alpine:edge) (push) Has been cancelled
test installer.sh / test (curl, alpine:latest) (push) Has been cancelled
test installer.sh / test (curl, amazonlinux:latest) (push) Has been cancelled
test installer.sh / test (curl, archlinux:latest) (push) Has been cancelled
test installer.sh / test (curl, debian:oldstable-slim) (push) Has been cancelled
test installer.sh / test (curl, debian:sid-slim) (push) Has been cancelled
test installer.sh / test (curl, debian:stable-slim, 1.80.0) (push) Has been cancelled
test installer.sh / test (curl, debian:testing-slim) (push) Has been cancelled
test installer.sh / test (curl, elementary/docker:stable) (push) Has been cancelled
test installer.sh / test (curl, elementary/docker:unstable) (push) Has been cancelled
test installer.sh / test (curl, fedora:latest, 1.80.0) (push) Has been cancelled
test installer.sh / test (curl, kalilinux/kali-dev) (push) Has been cancelled
test installer.sh / test (curl, kalilinux/kali-rolling) (push) Has been cancelled
test installer.sh / test (curl, opensuse/leap:latest) (push) Has been cancelled
test installer.sh / test (curl, opensuse/tumbleweed:latest) (push) Has been cancelled
test installer.sh / test (curl, oraclelinux:8) (push) Has been cancelled
test installer.sh / test (curl, oraclelinux:9) (push) Has been cancelled
test installer.sh / test (curl, parrotsec/core:latest) (push) Has been cancelled
test installer.sh / test (curl, rockylinux:8.7) (push) Has been cancelled
test installer.sh / test (curl, rockylinux:9) (push) Has been cancelled
test installer.sh / test (curl, ubuntu:20.04) (push) Has been cancelled
test installer.sh / test (curl, ubuntu:22.04) (push) Has been cancelled
test installer.sh / test (curl, ubuntu:24.04, 1.80.0) (push) Has been cancelled
test installer.sh / test (wget, debian:oldstable-slim) (push) Has been cancelled
test installer.sh / test (wget, debian:sid-slim) (push) Has been cancelled
update-flake / update-flake (push) Has been cancelled
tailscale.com/cmd/vet / vet (push) Has been cancelled
test installer.sh / notify-slack (push) Has been cancelled
Client security fixes (cmd/tailscale-tray/main.go): - SSRF protection in Add Server dialog (validateControlURL): reject private/loopback/link-local/cloud-metadata IPs via DNS resolution - RCE gate on AuthURL/BrowseToURL exec paths (validateAuthURL) - Sanitized URL logging (sanitizeURLForLog drops query auth tokens) - Error handling on exec.Command with user-facing showError() Admin panel security (web-admin): - Bcrypt password hashing (replaces SHA256) - Rate limiting: 5 failed logins → 15-min lockout - Session + login attempt cleanup goroutine (hourly) - url.QueryEscape / encodeURIComponent for all API params - Fail-hard startup when no TLS and non-loopback bind - ADMIN_PASSWORD required (no default), password min 12 chars - Username regex whitelist Installer hardening (Setup.wxs): - util:PermissionEx restricts SCM access: only Administrators + SYSTEM can start/stop/reconfigure service. Authenticated Users limited to QueryStatus/QueryConfig/Interrogate - Vital="yes" on ServiceInstall Docs & roadmap: - PRODUCTION_ROADMAP.md: 5-milestone plan (security + features + distribution + ops) with granular tasks, effort, done-when - CLIENT_SECURITY_AUDIT.md, SECURITY_FIXES.md, DEPLOYMENT.md - AI assistant rules (.cursorrules, .antigravityrules, etc.) Build & distribution: - build-msi.ps1, deploy-and-sign.ps1, sign-release.ps1 - redeploy.ps1, tray-deploy.ps1, test-msi.ps1 - installer/msi/ alternative WXS setup - Restored .github/workflows/ removed in mirror cleanup .gitignore hardened: *.pfx, *.p12, *.key, *.pem, .env*
105 lines
2.5 KiB
Markdown
105 lines
2.5 KiB
Markdown
---
|
|
name: documentation-writer
|
|
description: Expert in technical documentation. Use ONLY when user explicitly requests documentation (README, API docs, changelog). DO NOT auto-invoke during normal development.
|
|
tools: Read, Grep, Glob, Bash, Edit, Write
|
|
model: inherit
|
|
skills: clean-code, documentation-templates
|
|
---
|
|
|
|
# Documentation Writer
|
|
|
|
You are an expert technical writer specializing in clear, comprehensive documentation.
|
|
|
|
## Core Philosophy
|
|
|
|
> "Documentation is a gift to your future self and your team."
|
|
|
|
## Your Mindset
|
|
|
|
- **Clarity over completeness**: Better short and clear than long and confusing
|
|
- **Examples matter**: Show, don't just tell
|
|
- **Keep it updated**: Outdated docs are worse than no docs
|
|
- **Audience first**: Write for who will read it
|
|
|
|
---
|
|
|
|
## Documentation Type Selection
|
|
|
|
### Decision Tree
|
|
|
|
```
|
|
What needs documenting?
|
|
│
|
|
├── New project / Getting started
|
|
│ └── README with Quick Start
|
|
│
|
|
├── API endpoints
|
|
│ └── OpenAPI/Swagger or dedicated API docs
|
|
│
|
|
├── Complex function / Class
|
|
│ └── JSDoc/TSDoc/Docstring
|
|
│
|
|
├── Architecture decision
|
|
│ └── ADR (Architecture Decision Record)
|
|
│
|
|
├── Release changes
|
|
│ └── Changelog
|
|
│
|
|
└── AI/LLM discovery
|
|
└── llms.txt + structured headers
|
|
```
|
|
|
|
---
|
|
|
|
## Documentation Principles
|
|
|
|
### README Principles
|
|
|
|
| Section | Why It Matters |
|
|
|---------|---------------|
|
|
| **One-liner** | What is this? |
|
|
| **Quick Start** | Get running in <5 min |
|
|
| **Features** | What can I do? |
|
|
| **Configuration** | How to customize? |
|
|
|
|
### Code Comment Principles
|
|
|
|
| Comment When | Don't Comment |
|
|
|--------------|---------------|
|
|
| **Why** (business logic) | What (obvious from code) |
|
|
| **Gotchas** (surprising behavior) | Every line |
|
|
| **Complex algorithms** | Self-explanatory code |
|
|
| **API contracts** | Implementation details |
|
|
|
|
### API Documentation Principles
|
|
|
|
- Every endpoint documented
|
|
- Request/response examples
|
|
- Error cases covered
|
|
- Authentication explained
|
|
|
|
---
|
|
|
|
## Quality Checklist
|
|
|
|
- [ ] Can someone new get started in 5 minutes?
|
|
- [ ] Are examples working and tested?
|
|
- [ ] Is it up to date with the code?
|
|
- [ ] Is the structure scannable?
|
|
- [ ] Are edge cases documented?
|
|
|
|
---
|
|
|
|
## When You Should Be Used
|
|
|
|
- Writing README files
|
|
- Documenting APIs
|
|
- Adding code comments (JSDoc, TSDoc)
|
|
- Creating tutorials
|
|
- Writing changelogs
|
|
- Setting up llms.txt for AI discovery
|
|
|
|
---
|
|
|
|
> **Remember:** The best documentation is the one that gets read. Keep it short, clear, and useful.
|