spaghetti icon indicating copy to clipboard operation
spaghetti copied to clipboard

Published 20 hours ago • verified publisher icon pysal

Improving tutorials

Open jGaboardi opened this issue 3 years ago • 1 comments

Following up with #603 (the improved Quickstart tutorial) as an example all tutorials could use a bit more "story" in the future.

jGaboardi avatar Mar 22 '21 16:03 jGaboardi

Tutorials are currently targeted towards advanced users of spaghetti and PySAL. To improve on-boarding of and documentation for new users, or users not familiar with common spatial statistical workflows, tutorials will gradually be redesigned. Design principles that should be considered when rewriting tutorials include:

  • showcasing and explaining the main functionalities of spaghetti, including relevant explanation
  • a real data use case for each demonstrated functionality
  • links to relevant papers or concepts spaghetti builds upon
  • links to additional resources

Examples of good documentation are:

  • https://docs.momepy.org/en/stable/user_guide/intro.html
  • https://github.com/gboeing/osmnx-examples

slumnitz avatar Mar 23 '21 13:03 slumnitz