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,19 +1,19 @@
import { Pattern } from "../actions/input/inputSpecTypes"
import * as regexes from "./regexes"
import { Pattern } from '../actions/input/inputSpecTypes'
import * as regexes from './regexes'
export const ipv6: Pattern = {
regex: regexes.ipv6.matches(),
description: "Must be a valid IPv6 address",
description: 'Must be a valid IPv6 address',
}
export const ipv4: Pattern = {
regex: regexes.ipv4.matches(),
description: "Must be a valid IPv4 address",
description: 'Must be a valid IPv4 address',
}
export const hostname: Pattern = {
regex: regexes.hostname.matches(),
description: "Must be a valid hostname",
description: 'Must be a valid hostname',
}
export const localHostname: Pattern = {
@@ -28,7 +28,7 @@ export const torHostname: Pattern = {
export const url: Pattern = {
regex: regexes.url.matches(),
description: "Must be a valid URL",
description: 'Must be a valid URL',
}
export const localUrl: Pattern = {
@@ -44,26 +44,26 @@ export const torUrl: Pattern = {
export const ascii: Pattern = {
regex: regexes.ascii.matches(),
description:
"May only contain ASCII characters. See https://www.w3schools.com/charsets/ref_html_ascii.asp",
'May only contain ASCII characters. See https://www.w3schools.com/charsets/ref_html_ascii.asp',
}
export const domain: Pattern = {
regex: regexes.domain.matches(),
description: "Must be a valid Fully Qualified Domain Name",
description: 'Must be a valid Fully Qualified Domain Name',
}
export const email: Pattern = {
regex: regexes.email.matches(),
description: "Must be a valid email address",
description: 'Must be a valid email address',
}
export const emailWithName: Pattern = {
regex: regexes.emailWithName.matches(),
description: "Must be a valid email address, optionally with a name",
description: 'Must be a valid email address, optionally with a name',
}
export const base64: Pattern = {
regex: regexes.base64.matches(),
description:
"May only contain base64 characters. See https://base64.guru/learn/base64-characters",
'May only contain base64 characters. See https://base64.guru/learn/base64-characters',
}