Draft
docs: fix readme inconsistencies and expand DSL documentation#2
Conversation
…/test/DSL docs Co-authored-by: diasbruno <362368+diasbruno@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Suggest updates for repository documentation
docs: fix readme inconsistencies and expand DSL documentation
Mar 14, 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 readme contained a typo, an outdated claim about JavaScript support, and a misleading "Generated artifacts" section that showed
door-event/door-stateoutput immediately after amy-type/another-classcode example — with no indication they were unrelated.Fixes
Restructured & expanded content
my-type/another-classusage example now shows its own generated Swift/Kotlin/JavaScript output; door-state-machine artifacts moved to a dedicated## Example: Door State Machinesection with a link to the example fileclass AnotherClass {}→class AnotherClass{}to match actual codegen:nameand:arrayopts, and the:classvs:datatypekind distinction — previously only visible by reading sourceregister-class: added usage example for registering a standalone class as a top-level artifactgenerate-artifact/compile-artifactAPI: added minimal usage snippet with supported targets listedmake tests✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.