updated doc guide with "documenting changes"#76
Conversation
There was a problem hiding this comment.
Thanks for adding this in @orbeckst :-) However, some of the code didn't render.
As an aside it's getting pretty hard to find things in this very long page; at least we should split up "Working with the code" and "Working with the code documentation"
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
Co-authored-by: Lily Wang <31115101+lilyminium@users.noreply.github.com>
|
Thanks for the link to the render and the fixes. I agree that the page should be split up. I was, however, mainly concerned with content. I think @IAlibay had some ideas regarding a dev guide – opinions? |
Yes :) Long term I think it would be really awesome if we could take the "contributing" parts of the user guide and spin them off into its own "developer guide". I think there's quite a lot of behind the scenes stuff that we could/should add (e.g. asv). I've not really spent time considering how much effort this would be to do, so I'd agree with @lilyminium short term splitting the page up makes sense. |
Taken from https://github.com/MDAnalysis/mdanalysis/wiki/WritingDocumentation#documenting-changes
in response to MDAnalysis/mdanalysis#2754 (comment)