add documentation for ai agents (#3115)

* add documentation for ai agents

* docs: consolidate CLAUDE.md and CONTRIBUTING.md, add style guidelines

- Refactor CLAUDE.md to reference CONTRIBUTING.md for build/test/format info
- Expand CONTRIBUTING.md with comprehensive build targets, env vars, and testing
- Add code style guidelines section with conventional commits
- Standardize SDK prettier config to use single quotes (matching web)
- Add project-level Claude Code settings to disable co-author attribution

* style(sdk): apply prettier with single quotes

Run prettier across sdk/base and sdk/package to apply the
standardized quote style (single quotes matching web).

* docs: add USER.md for per-developer TODO filtering

- Add agents/USER.md to .gitignore (contains user identifier)
- Document session startup flow in CLAUDE.md:
  - Create USER.md if missing, prompting for identifier
  - Filter TODOs by @username tags
  - Offer relevant TODOs on session start

* docs: add i18n documentation task to agent TODOs

* docs: document i18n ID patterns in core/

Add agents/i18n-patterns.md covering rust-i18n setup, translation file
format, t!() macro usage, key naming conventions, and locale selection.
Remove completed TODO item and add reference in CLAUDE.md.

* chore: clarify that all builds work on any OS with Docker
This commit is contained in:
Aiden McClelland
2026-02-06 00:10:16 +01:00
committed by GitHub
parent 86ca23c093
commit f2142f0bb3
280 changed files with 6793 additions and 5515 deletions

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { Session } from "./Session"
import type { Session } from './Session'
export type Sessions = { [key: string]: Session }

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { Pem } from "./Pem"
import type { Pem } from './Pem'
export type TunnelCertData = { key: Pem; cert: Pem }

View File

@@ -1,10 +1,10 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { AnyVerifyingKey } from "./AnyVerifyingKey"
import type { PortForwards } from "./PortForwards"
import type { Sessions } from "./Sessions"
import type { SignerInfo } from "./SignerInfo"
import type { WebserverInfo } from "./WebserverInfo"
import type { WgServer } from "./WgServer"
import type { AnyVerifyingKey } from './AnyVerifyingKey'
import type { PortForwards } from './PortForwards'
import type { Sessions } from './Sessions'
import type { SignerInfo } from './SignerInfo'
import type { WebserverInfo } from './WebserverInfo'
import type { WgServer } from './WgServer'
export type TunnelDatabase = {
webserver: WebserverInfo

View File

@@ -1,5 +1,5 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { TunnelCertData } from "./TunnelCertData"
import type { TunnelCertData } from './TunnelCertData'
export type WebserverInfo = {
enabled: boolean

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { Base64 } from "./Base64"
import type { Base64 } from './Base64'
export type WgConfig = { name: string; key: Base64; psk: Base64 }

View File

@@ -1,5 +1,5 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { Base64 } from "./Base64"
import type { WgSubnetMap } from "./WgSubnetMap"
import type { Base64 } from './Base64'
import type { WgSubnetMap } from './WgSubnetMap'
export type WgServer = { port: number; key: Base64; subnets: WgSubnetMap }

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { WgConfig } from "./WgConfig"
import type { WgConfig } from './WgConfig'
export type WgSubnetClients = { [key: string]: WgConfig }

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { WgSubnetClients } from "./WgSubnetClients"
import type { WgSubnetClients } from './WgSubnetClients'
export type WgSubnetConfig = { name: string; clients: WgSubnetClients }

View File

@@ -1,4 +1,4 @@
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { WgSubnetConfig } from "./WgSubnetConfig"
import type { WgSubnetConfig } from './WgSubnetConfig'
export type WgSubnetMap = { [key: string]: WgSubnetConfig }