Skip to content

docs: fix readme inconsistencies and expand DSL documentation#2

Draft
diasbruno with Copilot wants to merge 2 commits into
developmentfrom
copilot/suggest-updates-documentation
Draft

docs: fix readme inconsistencies and expand DSL documentation#2
diasbruno with Copilot wants to merge 2 commits into
developmentfrom
copilot/suggest-updates-documentation

Conversation

Copilot AI commented Mar 14, 2026

Copy link
Copy Markdown

The readme contained a typo, an outdated claim about JavaScript support, and a misleading "Generated artifacts" section that showed door-event/door-state output immediately after a my-type/another-class code example — with no indication they were unrelated.

Fixes

  • Typo: "of if" → "or if"
  • Stale info: "soon javascript" — JS is fully implemented and now listed as supported

Restructured & expanded content

  • Separated examples: my-type/another-class usage example now shows its own generated Swift/Kotlin/JavaScript output; door-state-machine artifacts moved to a dedicated ## Example: Door State Machine section with a link to the example file
  • Kotlin output: corrected class AnotherClass {}class AnotherClass{} to match actual codegen
  • Constructor argument options: documented :name and :array opts, and the :class vs :datatype kind distinction — previously only visible by reading source
  • register-class: added usage example for registering a standalone class as a top-level artifact
  • generate-artifact / compile-artifact API: added minimal usage snippet with supported targets listed
  • Installation: Quicklisp setup instructions
  • Running tests: make 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.

…/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
Copilot AI requested a review from diasbruno March 14, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants