Skip to content

Conversation

@orbeckst
Copy link
Member

@lilyminium
Copy link
Member

lilyminium commented Jun 15, 2020

Copy link
Member

@lilyminium lilyminium left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

@lilyminium lilyminium mentioned this pull request Jun 15, 2020
orbeckst and others added 7 commits June 15, 2020 09:36
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>
@orbeckst
Copy link
Member Author

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?

@IAlibay
Copy link
Member

IAlibay commented Jun 15, 2020

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.

@lilyminium lilyminium merged commit a4dddc6 into master Jun 18, 2020
@lilyminium lilyminium deleted the update-doc-guide-documenting-changes branch June 18, 2020 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants