act-rules / act-rules-web

Source for ACT Rules website
https://act-rules.github.io/
Other
3 stars 5 forks source link

Move examples out of the definitions #158

Closed WilcoFiers closed 4 years ago

WilcoFiers commented 4 years ago

We've recently started adding examples to the definitions. I think this helps, but they are sort of disruptive of the reading flow. It would be better if the examples weren't included into every rule in the default view. I think there are two ways we can do this:

  1. Either we move the examples into their own page. Drawback of that is it will be more cumbersome to maintain them and keep them up to date
  2. We can put them into a collapsable region, perhaps through summary / details elements. Drawback there is it's a little more work to implement.

Here's an example of what it looks like currently: https://act-rules.github.io/rules/59796f#accessible-name

WilcoFiers commented 4 years ago

Proposal was accepted during a previous meeting. @jkodu will take on this task.

jeeyyy commented 4 years ago

To implement act-rules/act-rules.github.io#2 above

Jym77 commented 4 years ago

I think this have been fixed in the main repo (by splitting out the examples in the files) and can be closed here.

jeeyyy commented 4 years ago

Nice one. Thanks for confirming @Jym77. Closing issue.