CoqPyt Documentation

[acmatthias]

This pull requests aims to add documentation to all aspects of CoqPyt to assist with the usage and contribution to this project as a whole. Users will be able to access documentation right from the readme, where they can then view a detailed description of the system. There are also links to access per class documentation for reference.

I hope that through this pull request, CoqPyt can become a more accessible tool that can allow more people to benefit from the incredible capabilities this project has.

Please let me know if there are any modifications that should be made to improve accessibility or clear up any confusion.

This project was completed under the supervision of Dr. Ali Ghanbari as an Honors Project for COMP 3700 Software Modeling and Design at Auburn University.

[Nfsaavedra]

Hello, first of all, thank you for your work. This level of detailed documentation for CoqPyt is genuinely valuable and much appreciated.

That said, keeping this documentation directly in the repository would introduce a maintenance burden that we’re not currently in a position to sustain. As the project evolves, we would need to continuously update diagrams and written content to keep everything accurate, which can quickly become difficult to manage.

A possible alternative would be to host this documentation in a separate repository. We could then update this project’s README to point to it. In that documentation repository, it would also be helpful to clearly indicate the latest commit or version of CoqPyt that the documentation corresponds to, so users can easily assess its relevance.

Let us know what you think about this approach.

[acmatthias]

That sounds great. I am assuming the repository should be created through the Software Reliability Lab GitHub team to keep all development of CoqPyt centrally located. I can then create a pull request there with everything in this pull request, but moved around to better suit it having its own repository.

[Nfsaavedra]

https://github.com/sr-lab/coqpyt-docs

I’ve created the repository. Feel free to open the pull request there.
It would also be great to include a well-structured README to complement the documentation.

Thanks!

[acmatthias]

Thank you very much! I will start working on transferring everything over there and then update the README.

I am also closing this pull request as it is no longer necessary.