-
Notifications
You must be signed in to change notification settings - Fork 15
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: initialize a user-facing mdbook #285
Conversation
Thanks for starting this, it was much needed! Also, I would like to use Alectryon to generate the documentation for Lean: I believe it would be super useful if we could display the goals in the documentation (it makes it easier to understand what the tactics do) and it will also give us a way of ensuring that the documentation stays up to date with the code (by checking that proofs in the doc don't break). |
Otherwise, `make test` won't build out of the box. Signed-off-by: Ryan Lahfa <ryan.lahfa@inria.fr>
cfd0bb3
to
4ac0b8b
Compare
Moved to an Alectryon setup. |
@Nadrieril I think it's important that you keep an eye on this PR as well. I just discussed with @RaitoBezarius : the PR will push to the branch |
@Nadrieril ping on this :) |
Design: - A flake similar to leanprover/lean4?subdir=docs/... - Alectryon + Lean-mdBook - CI + build Signed-off-by: Ryan Lahfa <ryan.lahfa@inria.fr>
5874ee6
to
250ec9a
Compare
@Nadrieril can i ping you for the merge? |
The PR #282 is blocked because the doc building fails. |
Urgh. |
Sent a hotfix in another PR. |
@sonmarcho @R1kM Here's my proposal regarding documenting
progress
among other things that I learned during the FV of AVL trees.A mdBook-style user facing documentation with a part on "Proving Rust code with Lean" which dumps all that I know about using Aeneas & Lean in practice on Rust code.
Question is: do I do everything in this PR or shall we just get the CI right and improve on it incrementally as we commit to an outline, etc. ?