Files

T

Joseph Doherty 51a9dadf62 Align docs with StyleGuide and add CLAUDE.md

- Rename 16 kebab-case docs to PascalCase per StyleGuide
- Move per-language client design docs from docs/ to clients/<lang>/
  alongside their READMEs
- Add ## Related Documentation sections to 15 docs that lacked one
- Fix sentence-case violations in H3 headings (StyleGuide rule)
- Update cross-references in gateway.md, client READMEs, scripts,
  and generate-proto.ps1 helpers to follow the new paths
- Add CLAUDE.md with build/test commands, the source-update
  verification matrix, the parity-first contract, and pointers
  to MXAccess and Galaxy Repository analysis sources

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-04-30 10:19:22 -04:00

2.2 KiB

Raw Permalink Blame History

Implementation Plan Index

This index defines the implementation order and a Gitea issue/milestone model for tracking the work.

Repository:

https://gitea.dohertylan.com/dohertj2/mxaccessgw

Implementation order:

Gateway process
MXAccess worker instance
Client libraries

Detailed plans:

docs/ImplementationPlanGateway.md
docs/ImplementationPlanMxAccessWorker.md
docs/ImplementationPlanClients.md

Gitea Milestones

Recommended milestones:

gateway-foundation
gateway-auth
gateway-sessions-ipc
gateway-grpc-events-dashboard
mxaccess-worker-foundation
mxaccess-worker-parity-slice
clients-dotnet
clients-go
clients-rust
clients-python
clients-java
integration-and-parity
packaging-and-ops

Gitea Labels

Recommended labels:

area:contracts
area:gateway
area:worker
area:dashboard
area:auth
area:client-dotnet
area:client-go
area:client-rust
area:client-python
area:client-java
area:tests
area:docs
type:feature
type:test
type:infra
type:docs
priority:p0
priority:p1
priority:p2
blocked

Issue Body Template

## Context

## Deliverables

## Acceptance Criteria

## Tests

## Dependencies

Definition Of Done

Every implementation issue should meet this baseline:

follows the relevant style guide in docs/style-guides/,
generated code is reproducible,
secrets are not logged,
unit tests pass,
docs are updated when behavior, commands, or paths change,
live MXAccess verification steps are documented when required.

Toolchain

Use docs/ToolchainLinks.md for installed compiler/runtime paths. If a new terminal cannot find a recently installed tool, refresh PATH:

$env:Path = [Environment]::GetEnvironmentVariable('Path','Machine') + ';' + [Environment]::GetEnvironmentVariable('Path','User')

2.2 KiB Raw Permalink Blame History