Updated doc structure and added contribution guide - Githubissues

spur-sim / spur

Simulation for Planning and Understanding Railways

MIT License

9 stars 4 forks source link

Updated doc structure and added contribution guide #49

Closed wklumpen closed 1 year ago

wklumpen commented 1 year ago

This pull requests largely consolidates the documentation available on Read the Docs based on Issue https://github.com/transit-analytics-lab/spur/issues/46.

Before this is changed to a full pull request, the following must be done:

[x] Creation of a "contribution guide" page showing how to set up a development environment for Spur
[x] Update of the structure of the "User Guide" and the developer reference
[x] Create a "quick start" example vignette using Line 4

wklumpen commented 1 year ago

@peterlai1 take a look.