-
Notifications
You must be signed in to change notification settings - Fork 268
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
Move documentation to diataxis #1391
Conversation
I am also trying to get readthedocs to display a build of the documentation as a check, so we should be able to click and view a built set of docs. (https://nashpy.readthedocs.io/en/latest/contributing/discussion/readthedocs/index.html) |
Got it working! (Apologies if you got GitHub emails informing you about authorisations to read the docs etc... So now on every PR we will have the read the docs report as an extra check: If you click on |
Thank you @drvinceknight |
This hopefully is only moving files in to 1 of the 4 classes of documentation described in #1387.
If we are happy with the restructure, I would suggest (in a future PR) further enhancements which would include moving some text in the how-to guides to discussion sections. There are some places where we discuss some of the theory behind a particular feature, this should/could be removed from the how-to guide and would be better placed in a discussion section.
This closes #1387