jrule icon indicating copy to clipboard operation
jrule copied to clipboard

Published 20 hours ago • verified publisher icon seaside1

Rework documentation

Open seime opened this issue 2 years ago • 9 comments

The README is beginning to become quite overloaded, and I assume some of the information is neither correct nor complete.

  • Maybe split examples to separate file?
  • Improve doc on creating testcases for rules?
  • Provide better doc on how to setup a user rule project using Maven or Gradle?

seime avatar Dec 28 '22 18:12 seime

agree completely, thought the same while merging the readme again and again. My thoughts were to use "cleanup" the integration tests and use this as examples. I created there temporary the rules to copy them to the examples to be typo safe.

querdenker2k avatar Dec 28 '22 18:12 querdenker2k

@seaside1 WDYT?

seime avatar Feb 05 '23 18:02 seime

Not sure. Should we keep the examples in .java-files have them checked in, so they can be changed. And then maybe only link to the source. Otherwise sounds good to make documentation better.

seaside1 avatar Feb 06 '23 21:02 seaside1

I have updated the examples of Readme now to reflect the refactoring in main.

seaside1 avatar Feb 16 '23 20:02 seaside1

I like the idea of having the examples as compilable java files. Makes it much easier to maintain as well.

seime avatar Feb 19 '23 16:02 seime

Should we close this one now?

seaside1 avatar Mar 12 '23 20:03 seaside1

I've been thinking about making this project into a maven multimodule project where the modules are

  1. the main jrule artifact (as today)
  2. all the examples as a compilable project
  3. an empty example project setup like jrules-user repo

WDYT?

seime avatar Mar 13 '23 07:03 seime

I still think having the examples as code is more secure (see the last merged typo) Putting this in a multimodule project seems to be a good idea.

querdenker2k avatar Mar 13 '23 21:03 querdenker2k

I also think it sounds good!

seaside1 avatar Mar 14 '23 19:03 seaside1