Skip to content
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

Merged
merged 12 commits into from
Jun 4, 2021
Merged

Conversation

drvinceknight
Copy link
Member

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

@drvinceknight drvinceknight changed the title Move documentation to diataxis [WIP] Move documentation to diataxis May 26, 2021
@drvinceknight
Copy link
Member Author

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)

@drvinceknight
Copy link
Member Author

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:

CleanShot 2021-05-26 at 14 44 22

If you click on Details you'll be taken to a build of the docs. For example for this PR: https://axelrod--1391.org.readthedocs.build/en/1391/

@drvinceknight drvinceknight changed the title [WIP] Move documentation to diataxis Move documentation to diataxis May 26, 2021
@Nikoleta-v3
Copy link
Member

Thank you @drvinceknight

@Nikoleta-v3 Nikoleta-v3 merged commit 75ef1f2 into dev Jun 4, 2021
@marcharper marcharper deleted the move-documentation-to-diataxis branch June 1, 2024 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganisation of documentation.
3 participants