menu

Statecharts

Statecharts are a precise, visual way of modeling the behaviour of complex reactive systems. They describe how things work, and can help you get your code doing exactly what you want.

Channels
Team

Glossary

July 8, 2018 at 4:08pm

I'm just patting myself on the back a bit. This week-end I've been busy hacking away at Jekyll, and today I can safely show off the "glossary page" where I've tried to define all the terms that get thrown around. These are linked to from various pages around statecharts.github.io, but until yesterday, there was no glossary page. I've tried to organize the terms in a simple hierarchy, shown by the breadcrumbs at the top

I've also worked on the metadata of the pages, so embedding a link to a glossary entry will now include a short definition of the term.

https://statecharts.github.io/glossary/self-transition.html


July 8, 2018 at 5:43pm

👏 well done, especially for the metadata

I love how the links look like when shared (e.g. on Slack)

like-fill
2
  • reply
  • like

Thanks! I am wondering what other metadata I want to add. That's the hardest part: figuring out what things are...

  • reply
  • like

Of course I wanted to ask, both old and new users, to give the main glossary page a read; are there any definitions you find lacking, wrong, or perhaps a missing term on this overview page?

https://statecharts.github.io/glossary/

  • reply
  • like

And thanks to @davidkpiano for suggesting synonyms! :)

like-fill
1
  • reply
  • like

I also took the time to add role attributes here and there, to make it (perhaps) more screen reader friendly. I don't have much in the way of testing this though...

  • reply
  • like