Skip to content

Modularize Documentation #4

@cuioss

Description

@cuioss

Summary

Currently the documentation is big document: README.adoc
This needs to modularized.

Tasks

  • Split up into sensible blocks
  • Move all elements to src/site/adoc. (Base for maven-site plugin), include into site.xml
  • Include / reference file in README.adoc: Info: adoc include does not work within gitHub, therefore it is about linking
  • Sync it with the corresponding package-javadoc files. Currently the README.adoc is more complete

Metadata

Metadata

Assignees

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions