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

Add Examples page to documentation, define structure of Examples page #17

Closed
mbrennwa opened this issue Feb 27, 2023 · 0 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@mbrennwa
Copy link
Owner

Add a page with examples. There should be a single "landing page" for readers looking for examples, so examples should not be scattered around the other pages in the manual. It's better to have all examples in one place, and provide links to them from the other manual pages.

What would be a good structure for the Examples page?

  • Structure by programs / tools? One section each for curvetrace, curveplot, curveprocess, curvematch?
  • Present fully worked examples starting with data acquisition with ``curvetrace", followed by data plotting and processing?
  • Best of both worlds: combine both! Use curvetrace examples than will be useful to continue in the other sections / examples!
@mbrennwa mbrennwa added the documentation Improvements or additions to documentation label Feb 27, 2023
@mbrennwa mbrennwa added this to the Complete documentation milestone Mar 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant