dalek-cryptography / dalek_workspace Goto Github PK

The auto-generated docs hosting is on Firebase instead of S3, so the DNS records need to be updated.

The files hosted under assets/ aren't kept in any repository, so they should be managed as part of this one.

Right now the Makefile has a really hacky manual configuration of cfg flags passed down to rustdoc, which prevents properly setting features.

@cathieyun pointed out that some formulas are broken; we found that it seems to be because the markdown writes \\\\ to get \\ in the HTML for a latex line-break, but Commonmark sometimes emits a <br>, which causes the formula to be broken into two text spans and fail to parse as math. Curiously, this does not happen on my local machine, so I temporarily deployed from my local machine to the hosting service, bypassing the deploy pipeline, but it will break again the next time the repo is updated.

The old Cloudfront setup had custom CORS headers to allow doc-internal.dalek.rs to load scripts from doc.dalek.rs, but now those are gone, so the KaTeX on doc-internal.dalek.rs is broken.

There should be a script that deploys the docs, preferably from CI