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.

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

Update or remove overview.html #31

Open
Marcono1234 opened this issue Jan 5, 2021 · 1 comment
Open

Update or remove overview.html #31

Marcono1234 opened this issue Jan 5, 2021 · 1 comment

Comments

@Marcono1234
Copy link
Contributor

It appears overview.html is not referenced anywhere and is quite outdated, e.g. it still lists the following requirement:

Java SE6 or Higher

It looks like commit 28f4679 accidentially removed it from the source folder, therefore it is not part of the javadoc anymore.

Would it make sense to move relevant information from it to the README and then remove overview.html, or to update it and add it to resources folder so it is part of the javadoc?

@shannah
Copy link
Owner

shannah commented Jan 6, 2021

Probably best to move relevant stuff to readme. Writing javadoc is a pain for formatting large pieces of content like "overviews".

I wrote a whole bunch of docs when I first developed it. There is also an extended blog post here that should probably be adapted to documentation within the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants