Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Modularize Documentation #4

Open
cuioss opened this issue Dec 27, 2022 · 2 comments
Open

Modularize Documentation #4

cuioss opened this issue Dec 27, 2022 · 2 comments
Assignees
@DLSV
Labels
documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Milestone
v1.1

Comments

@cuioss
Copy link
Owner

cuioss commented Dec 27, 2022 •
edited
Loading

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
@cuioss cuioss added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers documentation labels Dec 27, 2022
@cuioss cuioss added this to the v1.1 milestone Dec 27, 2022
@DLSV
Copy link

DLSV commented Jan 11, 2023

Hello,

I'd like to help out with this issue. Let me know if there's anything else to take into account.

@cuioss
Copy link
Owner Author

cuioss commented Jan 11, 2023

Hi DLSV
Welcome to our CUIOSS project(s)
Thanks for the offer, this is very much appreciated.
You are welcome to this issue.
Regards
Oliver

@cuioss cuioss closed this as completed Jan 11, 2023
@cuioss cuioss reopened this Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DLSV DLSV

Labels
documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
v1.1
Development

No branches or pull requests
2 participants
@cuioss @DLSV