Skip to content
This repository has been archived by the owner on Aug 1, 2023. It is now read-only.

Add javadoc and dokka docs website to Tuweni website #124

Closed
atoulme opened this issue Jul 13, 2020 · 9 comments
Closed

Add javadoc and dokka docs website to Tuweni website #124

atoulme opened this issue Jul 13, 2020 · 9 comments
Labels
Milestone

Comments

@atoulme
Copy link
Member

atoulme commented Jul 13, 2020

We have the ability to generate javadoc and dokka docs for Apache Tuweni, but it's not been maintained.

  • Look at it and make sure this works well again.
  • Take the latest bin release and make it part of the website, by unzipping it and adding it to the gh-pages branch of the repo.
@sirinath
Copy link

sirinath commented Dec 10, 2020

Minimally there should be the JavaDocs but more generic tutorials are desirable.

@atoulme
Copy link
Member Author

atoulme commented Dec 15, 2020

What would you like to see first?

@sirinath
Copy link

I guess java docs are the low hanging fruit. Then write some tutirials.

@atoulme
Copy link
Member Author

atoulme commented Dec 15, 2020

So we have javadocs. We are going to get them published. Do you have an inclination for which tutorials to write?

@sirinath
Copy link

I think it would be good to start with some basic getting started tutorial. Also overview of the features and the basics of how they can be used.

@atoulme
Copy link
Member Author

atoulme commented Dec 31, 2020

94dc05b adds dokka docs to the website, you can now consult them here: http://tuweni.apache.org/docs/

@sirinath
Copy link

sirinath commented Jan 1, 2021

That's great! Will have a look.

@atoulme atoulme added the docs label Jan 2, 2021
@atoulme atoulme added this to the 1.4.0 milestone Jan 2, 2021
@atoulme
Copy link
Member Author

atoulme commented Jan 2, 2021

Also added a getting started guide for bytes - http://tuweni.apache.org/tutorials/getting-started-with-bytes/

@atoulme
Copy link
Member Author

atoulme commented Jan 17, 2021

Closing the issue! Let me know if you have something you'd like to see.

@atoulme atoulme closed this as completed Jan 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants