Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving tutorials #604

Open
jGaboardi opened this issue Mar 22, 2021 · 1 comment
Open

Improving tutorials #604

jGaboardi opened this issue Mar 22, 2021 · 1 comment
Assignees
Labels
enhancement good first issue Good issues to explore and get to know the package. notebooks wishlist

Comments

@jGaboardi
Copy link
Member

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

@slumnitz
Copy link
Member

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:

@slumnitz slumnitz added the good first issue Good issues to explore and get to know the package. label Mar 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Good issues to explore and get to know the package. notebooks wishlist
Projects
None yet
Development

No branches or pull requests

2 participants