Let a JVM reader follow the tutorial, and close the C#-side gaps - #2710
Merged
Merged
Conversation
Arc instruments its own command and query pipelines and says nothing about it, so the spans exist and nobody knows to subscribe to them. The JVM backend documents its observability in full, which left the C# side the one with a shipped feature and no page. Name the activity source and the eight spans, and say what each identifies. Registration is internal, so this documents the telemetry a consumer can observe rather than an extension point they can implement - the useful thing is knowing to add the source and what will show up.
The attribute surface was documented wherever each attribute happened to be used, so there was no page answering "what can I write on a type, and where may it go". The JVM backend has exactly that, which made the C# side the one a reader had to assemble for themselves. List them grouped by concern with their valid targets, and mark the ones that arrive with Chronicle rather than Arc, since those need a different package. Names and targets are taken from the attribute declarations.
The tutorial is the product's one threaded introduction, and four of its five chapters showed C# only, so a Kotlin or Java reader was sent to a getting-started page and left to work out the rest. Show the eight teaching examples in both languages. The setup around them stays per-backend prose rather than tabs, because a Gradle task and a dotnet build are not two spellings of one step: proxy generation, the MongoDB replica set, the relational unique index and the development principal each get a note naming the JVM equivalent instead. Chapter two needed a correction rather than a translation. It says the form validates for free once a rule exists, and on the JVM that holds only for the literal rules the shared fluent validator can project to the client; an imperative validator runs on the server alone. The chapter now says which is which rather than promising both readers the same outcome.
woksin
added
the
no-release
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on
docs/arc-shared-examples(#2709), which is stacked ondocs/arc-multi-implementation(#2708). Review those first.Closes the last gaps that made the documentation read as C#-first.
Added
internal, so this documents the telemetry a consumer can observe rather than an extension point they can implement — the useful part is knowing to add the source and what will show up.Changed
Fixed
Verification
All 41 C# snippets compile against real Arc source, up from 33. Arc's gate is green: 335 files, 364 links.
The matching Kotlin snippets are in
Cratis/Arc.Kotlin. They compile in CI; the machine this was written on has no JVM, so CI is their first real compile.