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

Start drafting user guide #727

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft

Start drafting user guide #727

wants to merge 18 commits into from

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Jul 16, 2022

Closes #719 and closes #697.

Changes proposed in this pull request:

  • Add a new user guide section.
  • Start adding contents of the user guide. The focus is on carving up the examples as needed and couching them in lots of explanatory text, with more connections between examples/sections than in the example gallery.

@codecov
Copy link

codecov bot commented Jul 16, 2022

Codecov Report

Merging #727 (b9e31d0) into main (a4a7d16) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #727   +/-   ##
=======================================
  Coverage   88.55%   88.55%           
=======================================
  Files          38       38           
  Lines        4368     4368           
=======================================
  Hits         3868     3868           
  Misses        500      500           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@tsalo tsalo added the documentation Improving documentation for the project label Aug 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improving documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Possible improvements for the user guide Create documentation for teaching users
1 participant