Skip to content

Modularize Documentation #4

Open
Open
Modularize Documentation#4
Assignees
DLSV
Labels
documentationenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed
Milestone
v1.1

Description

@cuioss-oliver
cuioss-oliver
opened on Dec 27, 2022

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions