Skip to content
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

Merged
merged 3 commits into from
Jul 10, 2024

Conversation

RaitoBezarius
Copy link
Contributor

@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. ?

@sonmarcho
Copy link
Member

sonmarcho commented Jul 9, 2024

Thanks for starting this, it was much needed!
Following our conversation, we should first get the CI right and do things incrementally. In particular, once we get the outline and the CI working, anybody can start making changes.

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>
@RaitoBezarius
Copy link
Contributor Author

Moved to an Alectryon setup.

@sonmarcho
Copy link
Member

sonmarcho commented Jul 9, 2024

@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 gh-pages; I will set up the github pages for this branch once it is created.

@RaitoBezarius
Copy link
Contributor Author

@Nadrieril ping on this :)

.github/workflows/build-userdocs.yml Outdated Show resolved Hide resolved
Ryan Lahfa and others added 2 commits July 9, 2024 20:38
Design:

- A flake similar to leanprover/lean4?subdir=docs/...
- Alectryon + Lean-mdBook
- CI + build

Signed-off-by: Ryan Lahfa <ryan.lahfa@inria.fr>
@RaitoBezarius
Copy link
Contributor Author

@Nadrieril can i ping you for the merge?

@Nadrieril Nadrieril merged commit 9e6f559 into AeneasVerif:main Jul 10, 2024
5 checks passed
@sonmarcho
Copy link
Member

The PR #282 is blocked because the doc building fails.

@RaitoBezarius
Copy link
Contributor Author

Urgh.

@RaitoBezarius
Copy link
Contributor Author

Sent a hotfix in another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants