Skip to content

Add documentation for the Lean backend (manual) #1682

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 15, 2025
Merged

Add documentation for the Lean backend (manual) #1682

merged 4 commits into from
Sep 15, 2025
+530 −3

Conversation

clementblaudeau
Copy link
Contributor

@clementblaudeau clementblaudeau commented Sep 11, 2025 •
edited by maximebuyse
Loading

This adds basic documentation for :

  • the monadic encoding
  • structs
  • enums
  • traits

It does not contain the documentation of the Lean lib (see #1610)

[skip changelog]

@clementblaudeau clementblaudeau requested a review from a team as a code owner September 11, 2025 13:47
W95Psp
W95Psp approved these changes Sep 11, 2025
View reviewed changes
Copy link
Member

@W95Psp W95Psp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me, thanks!
My only worry is that the Lean backend is evolving fast, so that document will need to be updated & maintained frequently.

@maximebuyse maximebuyse added this pull request to the merge queue Sep 15, 2025
Merged via the queue into main with commit bbc1f47 Sep 15, 2025
18 of 19 checks passed
@maximebuyse maximebuyse deleted the lean-docs-internals branch September 15, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@W95Psp W95Psp W95Psp approved these changes

@karthikbhargavan karthikbhargavan Awaiting requested review from karthikbhargavan karthikbhargavan is a code owner automatically assigned from cryspen/hax

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@clementblaudeau @W95Psp @maximebuyse