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
Abella documentation is woefully incomplete #80
Comments
Here is a list to get things started:
It would also be nice to have somewhere an annotated directory of the examples, briefly describing what each example is about, as well as which technical aspects of theorem proving in Abella are illustrated by those examples. |
Thanks Todd. I took the liberty of turning your bullets into checkboxes. About the annotated directory, I am not sure if it makes sense to divide them up based on what features of Abella they use. We can perhaps improve this page a bit. |
I wasn't suggesting reorganizing the examples in any way; I think the current organization is just fine. I was just thinking that a title alone is not enough information for someone looking for ideas on how to organize a development. Perhaps a brief paragraph on each example, with information on what techniques are illustrated by the example, would go a long way to help someone looking for ideas. I could try doing a few to illustrate better what I'm suggesting. Also, it would be nice if there were a way to add a stylized comment in the example code itself that is automatically picked up by the website generation tool and turned into the blurb in the directory. |
Yes, @ThatDaleMiller and I have been discussing how to add a little bit of literate programming support to Abella so that we can interleave documentation and code in a web-page. We can try to steal ideas from Literate Haskell, Isabelle, Coq. or even use some turnkey solution such as noweb. |
It will be good to consider this for: abella-prover/abella-prover.org#4 |
I have updated this document with more about stratification. |
Please list here things that you were not able to find good documentation for. This will let us prioritize what needs to be fixed/updated.
The text was updated successfully, but these errors were encountered: