From c61c4d93c19da51451a7172a83e4943477b9256b Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Wed, 1 May 2019 15:13:30 +1000 Subject: [PATCH] Added a quick 'documentation.md' file, to describe where the Lighthouse technical documentation is, and how it can be updated. --- docs/documentation.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/documentation.md diff --git a/docs/documentation.md b/docs/documentation.md new file mode 100644 index 0000000000..3600558878 --- /dev/null +++ b/docs/documentation.md @@ -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. +