dohertj2/mxaccessgw
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Align docs with StyleGuide and add CLAUDE.md

Browse Source 
- 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>
This commit is contained in:
Joseph Doherty
2026-04-30 10:19:22 -04:00
parent 133c83029b
commit 51a9dadf62
45 changed files with 522 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files
gateway.md
+7 -7
View File
@@ -42,25 +42,25 @@ transport.
Detailed follow-up docs:
- `docs/gateway-process-design.md` covers the .NET 10 gateway process,
- `docs/GatewayProcessDesign.md` covers the .NET 10 gateway process,
session manager, worker supervision, gRPC API, event streaming, fault model,
security, observability, and test strategy.
- `docs/WorkerFrameProtocol.md` covers the gateway-side named-pipe frame
reader/writer and `WorkerEnvelope` validation rules.
- `docs/WorkerProcessLauncher.md` covers worker executable validation, process
launch arguments, nonce handling, and startup cleanup behavior.
- `docs/mxaccess-worker-instance-design.md` covers each .NET Framework 4.8 x86
- `docs/MxAccessWorkerInstanceDesign.md` covers each .NET Framework 4.8 x86
MXAccess worker instance, including STA ownership, message pumping, COM
lifetime, command dispatch, event sinks, conversion, and shutdown.
- `docs/design-decisions.md` records current v1 choices, including API-key
- `docs/DesignDecisions.md` records current v1 choices, including API-key
authentication in gateway-owned SQLite and the concrete installed MXAccess
COM class details from `C:\Users\dohertj2\Desktop\mxaccess`.
- `docs/gateway-dashboard-design.md` covers the Blazor Server and Bootstrap
- `docs/GatewayDashboardDesign.md` covers the Blazor Server and Bootstrap
dashboard for live gateway/session/worker status.
- `docs/client-libraries-design.md` covers shared design requirements for
- `docs/ClientLibrariesDesign.md` covers shared design requirements for
official gRPC client libraries, test CLIs, and tests for .NET C#, Go, Rust,
Python, and Java.
- `docs/implementation-plan-index.md` links the detailed implementation plans
- `docs/ImplementationPlanIndex.md` links the detailed implementation plans
and recommended Gitea milestones/issues.
- `docs/GalaxyRepository.md` covers the read-only Galaxy Repository browse
RPCs that let clients enumerate the deployed object hierarchy and dynamic
@@ -950,7 +950,7 @@ backend = mxaccess-worker
## Open Questions
Current v1 decisions are recorded in `docs/design-decisions.md`.
Current v1 decisions are recorded in `docs/DesignDecisions.md`.
Resolved for v1: