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,226 +1,226 @@
export { AcceptSigners } from "./AcceptSigners"
export { AcmeProvider } from "./AcmeProvider"
export { AcmeSettings } from "./AcmeSettings"
export { ActionId } from "./ActionId"
export { ActionInput } from "./ActionInput"
export { ActionMetadata } from "./ActionMetadata"
export { ActionResultMember } from "./ActionResultMember"
export { ActionResult } from "./ActionResult"
export { ActionResultV0 } from "./ActionResultV0"
export { ActionResultV1 } from "./ActionResultV1"
export { ActionResultValue } from "./ActionResultValue"
export { ActionVisibility } from "./ActionVisibility"
export { AddAdminParams } from "./AddAdminParams"
export { AddAssetParams } from "./AddAssetParams"
export { AddCategoryParams } from "./AddCategoryParams"
export { AddMirrorParams } from "./AddMirrorParams"
export { AddPackageParams } from "./AddPackageParams"
export { AddPackageSignerParams } from "./AddPackageSignerParams"
export { AddPackageToCategoryParams } from "./AddPackageToCategoryParams"
export { AddressInfo } from "./AddressInfo"
export { AddSslOptions } from "./AddSslOptions"
export { AddTunnelParams } from "./AddTunnelParams"
export { AddVersionParams } from "./AddVersionParams"
export { Alerts } from "./Alerts"
export { Algorithm } from "./Algorithm"
export { AllowedStatuses } from "./AllowedStatuses"
export { AllPackageData } from "./AllPackageData"
export { AlpnInfo } from "./AlpnInfo"
export { AnySignature } from "./AnySignature"
export { AnySigningKey } from "./AnySigningKey"
export { AnyVerifyingKey } from "./AnyVerifyingKey"
export { ApiState } from "./ApiState"
export { AttachParams } from "./AttachParams"
export { BackupProgress } from "./BackupProgress"
export { BackupTargetFS } from "./BackupTargetFS"
export { Base64 } from "./Base64"
export { BindId } from "./BindId"
export { BindInfo } from "./BindInfo"
export { BindingGatewaySetEnabledParams } from "./BindingGatewaySetEnabledParams"
export { BindOptions } from "./BindOptions"
export { BindParams } from "./BindParams"
export { Blake3Commitment } from "./Blake3Commitment"
export { BlockDev } from "./BlockDev"
export { BuildArg } from "./BuildArg"
export { CallbackId } from "./CallbackId"
export { Category } from "./Category"
export { Celsius } from "./Celsius"
export { CheckDependenciesParam } from "./CheckDependenciesParam"
export { CheckDependenciesResult } from "./CheckDependenciesResult"
export { Cifs } from "./Cifs"
export { ClearActionsParams } from "./ClearActionsParams"
export { ClearBindingsParams } from "./ClearBindingsParams"
export { ClearCallbacksParams } from "./ClearCallbacksParams"
export { ClearServiceInterfacesParams } from "./ClearServiceInterfacesParams"
export { ClearTasksParams } from "./ClearTasksParams"
export { CliSetIconParams } from "./CliSetIconParams"
export { ContactInfo } from "./ContactInfo"
export { CreateSubcontainerFsParams } from "./CreateSubcontainerFsParams"
export { CreateTaskParams } from "./CreateTaskParams"
export { CurrentDependencies } from "./CurrentDependencies"
export { CurrentDependencyInfo } from "./CurrentDependencyInfo"
export { DataUrl } from "./DataUrl"
export { Dependencies } from "./Dependencies"
export { DependencyMetadata } from "./DependencyMetadata"
export { DependencyRequirement } from "./DependencyRequirement"
export { DepInfo } from "./DepInfo"
export { Description } from "./Description"
export { DesiredStatus } from "./DesiredStatus"
export { DestroySubcontainerFsParams } from "./DestroySubcontainerFsParams"
export { DeviceFilter } from "./DeviceFilter"
export { DnsSettings } from "./DnsSettings"
export { DomainSettings } from "./DomainSettings"
export { Duration } from "./Duration"
export { EchoParams } from "./EchoParams"
export { EditSignerParams } from "./EditSignerParams"
export { EncryptedWire } from "./EncryptedWire"
export { ErrorData } from "./ErrorData"
export { EventId } from "./EventId"
export { ExportActionParams } from "./ExportActionParams"
export { ExportServiceInterfaceParams } from "./ExportServiceInterfaceParams"
export { FileType } from "./FileType"
export { FullIndex } from "./FullIndex"
export { FullProgress } from "./FullProgress"
export { GatewayId } from "./GatewayId"
export { GatewayInfo } from "./GatewayInfo"
export { GetActionInputParams } from "./GetActionInputParams"
export { GetContainerIpParams } from "./GetContainerIpParams"
export { GetHostInfoParams } from "./GetHostInfoParams"
export { GetOsAssetParams } from "./GetOsAssetParams"
export { GetOsVersionParams } from "./GetOsVersionParams"
export { GetPackageParams } from "./GetPackageParams"
export { GetPackageResponseFull } from "./GetPackageResponseFull"
export { GetPackageResponse } from "./GetPackageResponse"
export { GetServiceInterfaceParams } from "./GetServiceInterfaceParams"
export { GetServiceManifestParams } from "./GetServiceManifestParams"
export { GetServicePortForwardParams } from "./GetServicePortForwardParams"
export { GetSslCertificateParams } from "./GetSslCertificateParams"
export { GetSslKeyParams } from "./GetSslKeyParams"
export { GetStatusParams } from "./GetStatusParams"
export { GetSystemSmtpParams } from "./GetSystemSmtpParams"
export { GigaBytes } from "./GigaBytes"
export { GitHash } from "./GitHash"
export { Governor } from "./Governor"
export { Guid } from "./Guid"
export { HardwareRequirements } from "./HardwareRequirements"
export { HealthCheckId } from "./HealthCheckId"
export { HostId } from "./HostId"
export { HostnameInfo } from "./HostnameInfo"
export { Hosts } from "./Hosts"
export { Host } from "./Host"
export { IdMap } from "./IdMap"
export { ImageConfig } from "./ImageConfig"
export { ImageId } from "./ImageId"
export { ImageMetadata } from "./ImageMetadata"
export { ImageSource } from "./ImageSource"
export { InitProgressRes } from "./InitProgressRes"
export { InstalledState } from "./InstalledState"
export { InstalledVersionParams } from "./InstalledVersionParams"
export { InstallingInfo } from "./InstallingInfo"
export { InstallingState } from "./InstallingState"
export { InstallParams } from "./InstallParams"
export { IpHostname } from "./IpHostname"
export { IpInfo } from "./IpInfo"
export { KeyboardOptions } from "./KeyboardOptions"
export { ListPackageSignersParams } from "./ListPackageSignersParams"
export { ListServiceInterfacesParams } from "./ListServiceInterfacesParams"
export { ListVersionSignersParams } from "./ListVersionSignersParams"
export { LocaleString } from "./LocaleString"
export { LoginParams } from "./LoginParams"
export { LshwDevice } from "./LshwDevice"
export { LshwDisplay } from "./LshwDisplay"
export { LshwProcessor } from "./LshwProcessor"
export { Manifest } from "./Manifest"
export { MaybeUtf8String } from "./MaybeUtf8String"
export { MebiBytes } from "./MebiBytes"
export { MerkleArchiveCommitment } from "./MerkleArchiveCommitment"
export { MetadataSrc } from "./MetadataSrc"
export { Metadata } from "./Metadata"
export { MetricsCpu } from "./MetricsCpu"
export { MetricsDisk } from "./MetricsDisk"
export { MetricsGeneral } from "./MetricsGeneral"
export { MetricsMemory } from "./MetricsMemory"
export { Metrics } from "./Metrics"
export { MountParams } from "./MountParams"
export { MountTarget } from "./MountTarget"
export { NamedHealthCheckResult } from "./NamedHealthCheckResult"
export { NamedProgress } from "./NamedProgress"
export { NetInfo } from "./NetInfo"
export { NetworkInfo } from "./NetworkInfo"
export { NetworkInterfaceInfo } from "./NetworkInterfaceInfo"
export { NetworkInterfaceType } from "./NetworkInterfaceType"
export { OnionHostname } from "./OnionHostname"
export { OsIndex } from "./OsIndex"
export { OsVersionInfoMap } from "./OsVersionInfoMap"
export { OsVersionInfo } from "./OsVersionInfo"
export { PackageDataEntry } from "./PackageDataEntry"
export { PackageDetailLevel } from "./PackageDetailLevel"
export { PackageId } from "./PackageId"
export { PackageIndex } from "./PackageIndex"
export { PackageInfoShort } from "./PackageInfoShort"
export { PackageInfo } from "./PackageInfo"
export { PackageState } from "./PackageState"
export { PackageVersionInfo } from "./PackageVersionInfo"
export { PasswordType } from "./PasswordType"
export { PathOrUrl } from "./PathOrUrl"
export { Pem } from "./Pem"
export { Percentage } from "./Percentage"
export { Progress } from "./Progress"
export { ProgressUnits } from "./ProgressUnits"
export { PublicDomainConfig } from "./PublicDomainConfig"
export { Public } from "./Public"
export { RecoverySource } from "./RecoverySource"
export { RegistryAsset } from "./RegistryAsset"
export { RegistryInfo } from "./RegistryInfo"
export { RemoveAdminParams } from "./RemoveAdminParams"
export { RemoveAssetParams } from "./RemoveAssetParams"
export { RemoveCategoryParams } from "./RemoveCategoryParams"
export { RemoveMirrorParams } from "./RemoveMirrorParams"
export { RemovePackageFromCategoryParams } from "./RemovePackageFromCategoryParams"
export { RemovePackageParams } from "./RemovePackageParams"
export { RemovePackageSignerParams } from "./RemovePackageSignerParams"
export { RemoveTunnelParams } from "./RemoveTunnelParams"
export { RemoveVersionParams } from "./RemoveVersionParams"
export { ReplayId } from "./ReplayId"
export { RequestCommitment } from "./RequestCommitment"
export { RunActionParams } from "./RunActionParams"
export { Security } from "./Security"
export { ServerInfo } from "./ServerInfo"
export { ServerSpecs } from "./ServerSpecs"
export { ServerStatus } from "./ServerStatus"
export { ServiceInterfaceId } from "./ServiceInterfaceId"
export { ServiceInterface } from "./ServiceInterface"
export { ServiceInterfaceType } from "./ServiceInterfaceType"
export { SessionList } from "./SessionList"
export { Sessions } from "./Sessions"
export { Session } from "./Session"
export { SetDataVersionParams } from "./SetDataVersionParams"
export { SetDependenciesParams } from "./SetDependenciesParams"
export { SetHealth } from "./SetHealth"
export { SetIconParams } from "./SetIconParams"
export { SetMainStatusStatus } from "./SetMainStatusStatus"
export { SetMainStatus } from "./SetMainStatus"
export { SetNameParams } from "./SetNameParams"
export { SetupExecuteParams } from "./SetupExecuteParams"
export { SetupInfo } from "./SetupInfo"
export { SetupProgress } from "./SetupProgress"
export { SetupResult } from "./SetupResult"
export { SetupStatusRes } from "./SetupStatusRes"
export { SignAssetParams } from "./SignAssetParams"
export { SignerInfo } from "./SignerInfo"
export { SmtpValue } from "./SmtpValue"
export { StartStop } from "./StartStop"
export { StatusInfo } from "./StatusInfo"
export { TaskCondition } from "./TaskCondition"
export { TaskEntry } from "./TaskEntry"
export { TaskInput } from "./TaskInput"
export { TaskSeverity } from "./TaskSeverity"
export { TaskTrigger } from "./TaskTrigger"
export { Task } from "./Task"
export { TestSmtpParams } from "./TestSmtpParams"
export { UpdatingState } from "./UpdatingState"
export { VerifyCifsParams } from "./VerifyCifsParams"
export { VersionSignerParams } from "./VersionSignerParams"
export { Version } from "./Version"
export { VolumeId } from "./VolumeId"
export { WifiInfo } from "./WifiInfo"
export { AcceptSigners } from './AcceptSigners'
export { AcmeProvider } from './AcmeProvider'
export { AcmeSettings } from './AcmeSettings'
export { ActionId } from './ActionId'
export { ActionInput } from './ActionInput'
export { ActionMetadata } from './ActionMetadata'
export { ActionResultMember } from './ActionResultMember'
export { ActionResult } from './ActionResult'
export { ActionResultV0 } from './ActionResultV0'
export { ActionResultV1 } from './ActionResultV1'
export { ActionResultValue } from './ActionResultValue'
export { ActionVisibility } from './ActionVisibility'
export { AddAdminParams } from './AddAdminParams'
export { AddAssetParams } from './AddAssetParams'
export { AddCategoryParams } from './AddCategoryParams'
export { AddMirrorParams } from './AddMirrorParams'
export { AddPackageParams } from './AddPackageParams'
export { AddPackageSignerParams } from './AddPackageSignerParams'
export { AddPackageToCategoryParams } from './AddPackageToCategoryParams'
export { AddressInfo } from './AddressInfo'
export { AddSslOptions } from './AddSslOptions'
export { AddTunnelParams } from './AddTunnelParams'
export { AddVersionParams } from './AddVersionParams'
export { Alerts } from './Alerts'
export { Algorithm } from './Algorithm'
export { AllowedStatuses } from './AllowedStatuses'
export { AllPackageData } from './AllPackageData'
export { AlpnInfo } from './AlpnInfo'
export { AnySignature } from './AnySignature'
export { AnySigningKey } from './AnySigningKey'
export { AnyVerifyingKey } from './AnyVerifyingKey'
export { ApiState } from './ApiState'
export { AttachParams } from './AttachParams'
export { BackupProgress } from './BackupProgress'
export { BackupTargetFS } from './BackupTargetFS'
export { Base64 } from './Base64'
export { BindId } from './BindId'
export { BindInfo } from './BindInfo'
export { BindingGatewaySetEnabledParams } from './BindingGatewaySetEnabledParams'
export { BindOptions } from './BindOptions'
export { BindParams } from './BindParams'
export { Blake3Commitment } from './Blake3Commitment'
export { BlockDev } from './BlockDev'
export { BuildArg } from './BuildArg'
export { CallbackId } from './CallbackId'
export { Category } from './Category'
export { Celsius } from './Celsius'
export { CheckDependenciesParam } from './CheckDependenciesParam'
export { CheckDependenciesResult } from './CheckDependenciesResult'
export { Cifs } from './Cifs'
export { ClearActionsParams } from './ClearActionsParams'
export { ClearBindingsParams } from './ClearBindingsParams'
export { ClearCallbacksParams } from './ClearCallbacksParams'
export { ClearServiceInterfacesParams } from './ClearServiceInterfacesParams'
export { ClearTasksParams } from './ClearTasksParams'
export { CliSetIconParams } from './CliSetIconParams'
export { ContactInfo } from './ContactInfo'
export { CreateSubcontainerFsParams } from './CreateSubcontainerFsParams'
export { CreateTaskParams } from './CreateTaskParams'
export { CurrentDependencies } from './CurrentDependencies'
export { CurrentDependencyInfo } from './CurrentDependencyInfo'
export { DataUrl } from './DataUrl'
export { Dependencies } from './Dependencies'
export { DependencyMetadata } from './DependencyMetadata'
export { DependencyRequirement } from './DependencyRequirement'
export { DepInfo } from './DepInfo'
export { Description } from './Description'
export { DesiredStatus } from './DesiredStatus'
export { DestroySubcontainerFsParams } from './DestroySubcontainerFsParams'
export { DeviceFilter } from './DeviceFilter'
export { DnsSettings } from './DnsSettings'
export { DomainSettings } from './DomainSettings'
export { Duration } from './Duration'
export { EchoParams } from './EchoParams'
export { EditSignerParams } from './EditSignerParams'
export { EncryptedWire } from './EncryptedWire'
export { ErrorData } from './ErrorData'
export { EventId } from './EventId'
export { ExportActionParams } from './ExportActionParams'
export { ExportServiceInterfaceParams } from './ExportServiceInterfaceParams'
export { FileType } from './FileType'
export { FullIndex } from './FullIndex'
export { FullProgress } from './FullProgress'
export { GatewayId } from './GatewayId'
export { GatewayInfo } from './GatewayInfo'
export { GetActionInputParams } from './GetActionInputParams'
export { GetContainerIpParams } from './GetContainerIpParams'
export { GetHostInfoParams } from './GetHostInfoParams'
export { GetOsAssetParams } from './GetOsAssetParams'
export { GetOsVersionParams } from './GetOsVersionParams'
export { GetPackageParams } from './GetPackageParams'
export { GetPackageResponseFull } from './GetPackageResponseFull'
export { GetPackageResponse } from './GetPackageResponse'
export { GetServiceInterfaceParams } from './GetServiceInterfaceParams'
export { GetServiceManifestParams } from './GetServiceManifestParams'
export { GetServicePortForwardParams } from './GetServicePortForwardParams'
export { GetSslCertificateParams } from './GetSslCertificateParams'
export { GetSslKeyParams } from './GetSslKeyParams'
export { GetStatusParams } from './GetStatusParams'
export { GetSystemSmtpParams } from './GetSystemSmtpParams'
export { GigaBytes } from './GigaBytes'
export { GitHash } from './GitHash'
export { Governor } from './Governor'
export { Guid } from './Guid'
export { HardwareRequirements } from './HardwareRequirements'
export { HealthCheckId } from './HealthCheckId'
export { HostId } from './HostId'
export { HostnameInfo } from './HostnameInfo'
export { Hosts } from './Hosts'
export { Host } from './Host'
export { IdMap } from './IdMap'
export { ImageConfig } from './ImageConfig'
export { ImageId } from './ImageId'
export { ImageMetadata } from './ImageMetadata'
export { ImageSource } from './ImageSource'
export { InitProgressRes } from './InitProgressRes'
export { InstalledState } from './InstalledState'
export { InstalledVersionParams } from './InstalledVersionParams'
export { InstallingInfo } from './InstallingInfo'
export { InstallingState } from './InstallingState'
export { InstallParams } from './InstallParams'
export { IpHostname } from './IpHostname'
export { IpInfo } from './IpInfo'
export { KeyboardOptions } from './KeyboardOptions'
export { ListPackageSignersParams } from './ListPackageSignersParams'
export { ListServiceInterfacesParams } from './ListServiceInterfacesParams'
export { ListVersionSignersParams } from './ListVersionSignersParams'
export { LocaleString } from './LocaleString'
export { LoginParams } from './LoginParams'
export { LshwDevice } from './LshwDevice'
export { LshwDisplay } from './LshwDisplay'
export { LshwProcessor } from './LshwProcessor'
export { Manifest } from './Manifest'
export { MaybeUtf8String } from './MaybeUtf8String'
export { MebiBytes } from './MebiBytes'
export { MerkleArchiveCommitment } from './MerkleArchiveCommitment'
export { MetadataSrc } from './MetadataSrc'
export { Metadata } from './Metadata'
export { MetricsCpu } from './MetricsCpu'
export { MetricsDisk } from './MetricsDisk'
export { MetricsGeneral } from './MetricsGeneral'
export { MetricsMemory } from './MetricsMemory'
export { Metrics } from './Metrics'
export { MountParams } from './MountParams'
export { MountTarget } from './MountTarget'
export { NamedHealthCheckResult } from './NamedHealthCheckResult'
export { NamedProgress } from './NamedProgress'
export { NetInfo } from './NetInfo'
export { NetworkInfo } from './NetworkInfo'
export { NetworkInterfaceInfo } from './NetworkInterfaceInfo'
export { NetworkInterfaceType } from './NetworkInterfaceType'
export { OnionHostname } from './OnionHostname'
export { OsIndex } from './OsIndex'
export { OsVersionInfoMap } from './OsVersionInfoMap'
export { OsVersionInfo } from './OsVersionInfo'
export { PackageDataEntry } from './PackageDataEntry'
export { PackageDetailLevel } from './PackageDetailLevel'
export { PackageId } from './PackageId'
export { PackageIndex } from './PackageIndex'
export { PackageInfoShort } from './PackageInfoShort'
export { PackageInfo } from './PackageInfo'
export { PackageState } from './PackageState'
export { PackageVersionInfo } from './PackageVersionInfo'
export { PasswordType } from './PasswordType'
export { PathOrUrl } from './PathOrUrl'
export { Pem } from './Pem'
export { Percentage } from './Percentage'
export { Progress } from './Progress'
export { ProgressUnits } from './ProgressUnits'
export { PublicDomainConfig } from './PublicDomainConfig'
export { Public } from './Public'
export { RecoverySource } from './RecoverySource'
export { RegistryAsset } from './RegistryAsset'
export { RegistryInfo } from './RegistryInfo'
export { RemoveAdminParams } from './RemoveAdminParams'
export { RemoveAssetParams } from './RemoveAssetParams'
export { RemoveCategoryParams } from './RemoveCategoryParams'
export { RemoveMirrorParams } from './RemoveMirrorParams'
export { RemovePackageFromCategoryParams } from './RemovePackageFromCategoryParams'
export { RemovePackageParams } from './RemovePackageParams'
export { RemovePackageSignerParams } from './RemovePackageSignerParams'
export { RemoveTunnelParams } from './RemoveTunnelParams'
export { RemoveVersionParams } from './RemoveVersionParams'
export { ReplayId } from './ReplayId'
export { RequestCommitment } from './RequestCommitment'
export { RunActionParams } from './RunActionParams'
export { Security } from './Security'
export { ServerInfo } from './ServerInfo'
export { ServerSpecs } from './ServerSpecs'
export { ServerStatus } from './ServerStatus'
export { ServiceInterfaceId } from './ServiceInterfaceId'
export { ServiceInterface } from './ServiceInterface'
export { ServiceInterfaceType } from './ServiceInterfaceType'
export { SessionList } from './SessionList'
export { Sessions } from './Sessions'
export { Session } from './Session'
export { SetDataVersionParams } from './SetDataVersionParams'
export { SetDependenciesParams } from './SetDependenciesParams'
export { SetHealth } from './SetHealth'
export { SetIconParams } from './SetIconParams'
export { SetMainStatusStatus } from './SetMainStatusStatus'
export { SetMainStatus } from './SetMainStatus'
export { SetNameParams } from './SetNameParams'
export { SetupExecuteParams } from './SetupExecuteParams'
export { SetupInfo } from './SetupInfo'
export { SetupProgress } from './SetupProgress'
export { SetupResult } from './SetupResult'
export { SetupStatusRes } from './SetupStatusRes'
export { SignAssetParams } from './SignAssetParams'
export { SignerInfo } from './SignerInfo'
export { SmtpValue } from './SmtpValue'
export { StartStop } from './StartStop'
export { StatusInfo } from './StatusInfo'
export { TaskCondition } from './TaskCondition'
export { TaskEntry } from './TaskEntry'
export { TaskInput } from './TaskInput'
export { TaskSeverity } from './TaskSeverity'
export { TaskTrigger } from './TaskTrigger'
export { Task } from './Task'
export { TestSmtpParams } from './TestSmtpParams'
export { UpdatingState } from './UpdatingState'
export { VerifyCifsParams } from './VerifyCifsParams'
export { VersionSignerParams } from './VersionSignerParams'
export { Version } from './Version'
export { VolumeId } from './VolumeId'
export { WifiInfo } from './WifiInfo'