Add developer notes to documentation

graphnet-team / graphnet

A Deep learning library for neutrino telescopes

https://graphnet-team.github.io/graphnet/

Apache License 2.0

90 stars 92 forks source link

Add developer notes to documentation #698

Closed RasmusOrsoe closed 5 months ago

RasmusOrsoe commented 5 months ago

This PR moves the contents of GETTING_STARTED.md and CONTRIBUTING.md into our documentation page, and additional text and corrections have been added.

The github readme has been updated such that the installation section points to the new installation matrix in the documentation.

To make it easier to review this PR, I've included the html files in html.zip . If you unzip and open index.html a local version of the documentation page should appear in your browser.

html.zip

Closes #401

RasmusOrsoe commented 5 months ago

@ArturoLlorente @Aske-Rosted checks are now passing. Please let me know if you need anything