Added a quick 'documentation.md' file, to describe where the Lighthouse technical documentation is, and how it can be updated.

This commit is contained in:
Luke Anderson 2019-05-01 15:13:30 +10:00
parent f68dff0e52
commit c61c4d93c1
No known key found for this signature in database
GPG Key ID: 44408169EC61E228

14
docs/documentation.md Normal file
View File

@ -0,0 +1,14 @@
# Lighthouse Technical Documentation
The technical documentation, as generated by Rust, is available at [lighthouse-docs.sigmaprime.io](http://lighthouse-docs.sigmaprime.io/).
This documentation is generated from Lighthouse and updated regularly.
### How to update:
- `cargo doc`: builds the docs inside the `target/doc/` directory.
- `aws s3 sync target/doc/ s3://lighthouse-docs.sigmaprime.io/`: Uploads all of the docs, as generated with `cargo doc`, to the S3 bucket.
**Note**: You will need appropriate credentials to make the upload.