-
Notifications
You must be signed in to change notification settings - Fork 3
Big docs reorganise and expand. #109
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
Conversation
|
@trexfeathers welcome and thanks for looking !
Great also to have anyone else comment on this, |
|
OK I have now reviewed all the API docs builds, fixed (hopefully) for correctness and updated, generally smoothed over and introduced some more cross-links into newer docs sections where it seemed obvious. So I reckon this is up to scratch now, pending any suggestions about structural improvements. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK I've read most of it. It is impressively comprehensive 💐
To-do for @trexfeathers:
- Review the
detailssection - Consider the overall structure/approachability
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
trexfeathers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is the rest of my review.
General thoughts
I think this is some of the most complete documentation we have, because it caters to all the different types of readers.
It is laid out in an approachable way that is also low maintenance, so I'm happy to merge with the current structure 👍👍👍
However
Given the excellent breadth of 'all-angles' content, it feels like a missed opportunity to not go all-in on Diataxis. From offline conversations this sounds deliberate, but I'm hoping we can come back in future to 'finish the job'?
|
Progress : New commit 3433c29 covers, I think, all the "original" review comments Meanwhile I start to think about the "newer set" of suggestions |
|
@trexfeathers thanks for your careful attention ! Probable exceptions, issues you've raised which I think I want to "pin" for now :
Please check it out + see what you think. On inspection, I think I probably don't need to merge from main before completing this (read on...) Differences currently waiting on main are only those from #112, to do with unpinning numpy to v2. Associated changes affect array printout and its tests. That does not create major problems here, as changes here are all docs with no functional effect. |
|
Hang on .... I just realised the initial "Introduction" tutorial has chunks of code that ought to be in rst "code-block"s. |
OK done that. Not sure what else I'm still missing at the last minute though 😥 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! We're down to 4 outstanding options, plus a final 5th conversation that needs no action.
Co-authored-by: Martin Yeo <[email protected]>
Co-authored-by: Martin Yeo <[email protected]>
trexfeathers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super! Thanks @pp-mo
|
Awesome, thanks for all your effort. 🥇 |
Closes #80
Refactored version of #105
Adds new sections on core data and general operations.
Integrates the how-to sections also
Todos: