Add pkg.go.dev examples for all public APIs#5
Merged
Conversation
Co-authored-by: aretw0 <14055273+aretw0@users.noreply.github.com>
Co-authored-by: aretw0 <14055273+aretw0@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add examples to improve Go documentation
Add pkg.go.dev examples for all public APIs
Feb 15, 2026
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
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.
The package lacks Go examples for pkg.go.dev, making API discovery and usage patterns unclear compared to sibling projects (lifecycle, loam, procio, trellis).
Changes
Added
example_test.gowith 11 testable examples covering:Generic APIs (domain-agnostic)
Example()- Basic TypedWatcher usage and state observationExampleTreeDiagram()- Hierarchical structure visualizationExampleComponentDiagram()- Component relationship diagramsExampleStateMachineDiagram()- State machine visualizationExampleAggregateWatchers()- Multi-component state aggregationExampleNewWatcherAdapter()- TypedWatcher → StateSnapshot conversionExampleAggregateEvents()- Multi-source event aggregationExampleWithStyles()- Custom Mermaid stylingLegacy APIs (worker/signal domain)
ExampleWorkerTreeDiagram()- Worker hierarchy visualizationExampleSignalStateMachine()- Signal handler state machineExampleSystemDiagram()- Combined signal/worker topologyExample Usage
All examples are deterministic (pass
-racedetector) and use minimal, self-contained code. Helper types included for copy-paste usage.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.