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,6 +1,6 @@
import { Effects } from "../Effects"
import * as T from "../types"
import { DropGenerator, DropPromise } from "./Drop"
import { Effects } from '../Effects'
import * as T from '../types'
import { DropGenerator, DropPromise } from './Drop'
export class GetSystemSmtp {
constructor(readonly effects: Effects) {}
@@ -27,7 +27,7 @@ export class GetSystemSmtp {
this.effects.onLeaveContext(() => {
resolveCell.resolve()
})
abort?.addEventListener("abort", () => resolveCell.resolve())
abort?.addEventListener('abort', () => resolveCell.resolve())
while (this.effects.isInContext && !abort?.aborted) {
let callback: () => void = () => {}
const waitForNext = new Promise<void>((resolve) => {
@@ -39,7 +39,7 @@ export class GetSystemSmtp {
})
await waitForNext
}
return new Promise<never>((_, rej) => rej(new Error("aborted")))
return new Promise<never>((_, rej) => rej(new Error('aborted')))
}
/**
@@ -49,7 +49,7 @@ export class GetSystemSmtp {
abort?: AbortSignal,
): AsyncGenerator<T.SmtpValue | null, never, unknown> {
const ctrl = new AbortController()
abort?.addEventListener("abort", () => ctrl.abort())
abort?.addEventListener('abort', () => ctrl.abort())
return DropGenerator.of(this.watchGen(ctrl.signal), () => ctrl.abort())
}
@@ -73,7 +73,7 @@ export class GetSystemSmtp {
}
} catch (e) {
console.error(
"callback function threw an error @ GetSystemSmtp.onChange",
'callback function threw an error @ GetSystemSmtp.onChange',
e,
)
}
@@ -82,7 +82,7 @@ export class GetSystemSmtp {
.catch((e) => callback(null, e))
.catch((e) =>
console.error(
"callback function threw an error @ GetSystemSmtp.onChange",
'callback function threw an error @ GetSystemSmtp.onChange',
e,
),
)