ist-dresden / composum-AI

Artificial intelligence services for the Composum Pages CMS and Adobe AEM : content creation and analysis, translation, suggestions, ...
http://ai.composum.com/
MIT License
3 stars 1 forks source link

Create a site for documentation and instructions #38

Closed stoerr closed 1 year ago

stoerr commented 1 year ago

Currently some documentation is at https://www.composum.com/home/blog/pages/composumAI.html / https://www.composum.com/home/pages/editing/Composum-AI.html and https://www.composum.com/home/blog/AEM/composumAI-AEM.html , and various .md files in the project itself. It is probably better to put that into a real site.

One way is to brush up the https://ist-dresden.github.io/composum-AI/ site on github. Things to do:

There are other variants to create sites for the projects like using mkdocs itself or employ Jekyll as Github Actions do normally for .md files, but having maven sites is already set up for many of our projects, and those can look surprisingly good and be nicely functional.

stoerr commented 1 year ago

command line for site from .github/workflows/master.yml:

mvn install javadoc:aggregate site site:stage