-
Notifications
You must be signed in to change notification settings - Fork 9
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
doc: Rework docs to align with Rust and other libs #93
Conversation
|
I think it's intended to re-generate the docs. It doesn't have the smarts yet to look if there was a real underlying change or not. |
The main purpose of this PR is to streamline the main README file and move some of the content from there into new files in the
docs
directory, similar to restructuring I'm doing in other repos:Because the existing
docs
directory contains the generated API docs, I renamed that dir toapi-docs
and updated the script command inpackage.json
. Unfortunately, re-running the script apparently touched ALL the generated API doc .md files, making this PR much bigger than anticipated.@tmathern I'm not sure if that's a problem...LMK if you want me to try to find a way to avoid this side-effect.