-
Notifications
You must be signed in to change notification settings - Fork 9
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
Documentation consolidation #68
Comments
There is a now a small README in |
The 'main page' for the code documentation produced by coq2html is |
The main Web site is now produced from the |
The compilation pipeline figure in Tikz is in |
The Web demo and documentation are now both contained in the same directory, which facilitates consistent code browsing from the demo and should avoids inconsistent links from the demo to the correct documented Coq code. |
Modules in
|
I've written a sort of "documentation template" for one of our languages ( While this may not be the right approach for all languages, this can be used as a kind of guide for the other languages. |
The code documentation is scattered at the moment. The README now points to querycert.github.io for documentation. We should have a well understood process to produce documentation, and a clear entry point for both developers (in the code) and users (in the place where the README points to).
Some of the work items include:
UPDATE:
Further edits of the code documentation in
doc/doc.html
should still happen so it looks more readable, and is more complete. Notably:coq/Utils
coq/Common
coq/Translations
coq/Compiler
The text was updated successfully, but these errors were encountered: