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

"Overtone User's Guide" badly out of date #519

Open
APCBoston opened this issue May 18, 2024 · 2 comments
Open

"Overtone User's Guide" badly out of date #519

APCBoston opened this issue May 18, 2024 · 2 comments

Comments

@APCBoston
Copy link

The book at https://overtone.github.io/docs.html#_introduction has an edition date in 2018 and many inconsistencies with the wiki and README.md

In particular

  1. It says JDK 8 is needed
  2. The sample project.clj pins overtone/overtone "0.10.3", which cost me several hours of headache against a solved issue.

Apart from these errors, it's pretty confusing to have a nice polished page like overtone.github.io with a "documentation" page that links to a lovely but out-of-date book, and a "source" link to GH with totally different, mutually-inconsistent (but more up to date) documentation.

If the book is to be retained and there isn't anybody with the time, knowledge, and willingness to update it, perhaps it could get a big eye-catching banner noting its datedness?

@plexus
Copy link
Contributor

plexus commented May 20, 2024

Hi @APCBoston ,

Thank you for trying out overtone, and apologies for that frustrating experience. The fact is that there's really only one person (i.e. me) working on overtone, and I only have maybe a handful of hours a month to dedicate to it. I ended up in this position by accident when I noticed the bad state the project was in about six months ago.

It's a ten year old project with lots of loose ends.. I unfortunately can't get to everything. We have documentation in three places, the repo, the wiki, and the website... I've fixed some of the stuff I noticed in the README and the wiki, but haven't gotten to the site yet. That manual was started I think six years ago by the last person who did significant maintenance on overtone.

Anyway your criticism is valid, low hanging fruit like that maven version should be fixed. I don't think we need to say much about the JVM, any JVM people are running is most likely fine. For the overtone version I would refer to the README, the version there is updated automatically with every release.

If you have a bit more time a small pr to the website would be much appreciated!

https://github.com/overtone/overtone.github.com

Thanks a lot!

@APCBoston
Copy link
Author

@plexus thanks for the info, sorry to hear you're on your own here! I'm just sort of trying this out, learning clojure and overtone together... can't say how long I'll be here but I'll try to at least submit a couple of PRs for the documentation issues I've filed.

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