-
Notifications
You must be signed in to change notification settings - Fork 114
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
Revamp documentation #752
Revamp documentation #752
Conversation
The objective of this commit is to: * Bring the documentation up to date, by removing/correcting the stale pieces * Introduce a new organzation approach to documentation making it easier to evolve it over time. * Reduce the text-density of the README In general this commit stives to add as little new information as possible and primarily re-organizes the existing documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Any reason for the leading docs-
on the filenames in the docs
directory?
Only change I'd really like to see made is the one to remove the duplicate cargo +stable install cargo-hack --locked
, others are all nits.
No strong reason. I wanted to make sure that we can easily move these files around if need be (independent of the directory) allowing us to fully disambiguate them from other markdown files (in case we introduce new ones). |
I'm not sure why the jobs seem to be stuck. I'll close and re-open. |
The objective of this commit is to:
In general this commit strives to add as little new information as possible and primarily re-organizes the existing documentation. The only extra documentation is the JavaScript API support, which was lacking as correctly noted in #749 (comment)
Checklist
javy-cli
andjavy-core
do not require updating CHANGELOG files.