-
Notifications
You must be signed in to change notification settings - Fork 12
enhancement: refactor documentation #28
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
enhancement: refactor documentation #28
Conversation
|
@berviantoleo I've included a new workflow for windows, as you suggested in #12. Should I also run the backend tests in that workflow, or its purpose is only to verify the installation with |
I don't think we need that for backend tests. Just for verifying the requirements file. |
Description
This PR fixes #12, by reorganizing the documentation under
docs/in many .md files, instead of a single bloatedREADME.md. In particular the directory structure insidedocs/mirrors the codebase structure. Asetup.mdhave been added to handle the installation guides for both Linux and Windows OSs. TheREADME.mdnow contains only the basic information about the documentation, explains how to run the basic flows using the targets of theMakefile, and refer to other documentation files for further details.Submitter checklist