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

Adjust content in the Tutorial, Examples, and Recipes sections #84

Open
klywang opened this issue Apr 17, 2020 · 2 comments
Open

Adjust content in the Tutorial, Examples, and Recipes sections #84

klywang opened this issue Apr 17, 2020 · 2 comments
Assignees

Comments

@klywang
Copy link
Contributor

klywang commented Apr 17, 2020

Issue Description

These sections use nearly identical examples. The main difference is the Tutorial section includes more description, while the Examples section condensed the scripts from the tutorials.

We'd like to open a discussion on the aim of each section and use these aims to improve the Tutorial and Examples sections.

Proposed change

TBD

@klywang klywang changed the title Add content Tutorial and Examples sections Add content Tutorial, Examples, and Recipes sections Apr 17, 2020
@klywang klywang changed the title Add content Tutorial, Examples, and Recipes sections Adjust content in the Tutorial, Examples, and Recipes sections Apr 20, 2020
@klywang
Copy link
Contributor Author

klywang commented Apr 20, 2020

The aims of the Tutorial, Examples, and Recipies sections are detailed below, according to discussion between @atravitz, @b-butler, @bdice, and @vyasr:

  • Tutorial
    • Explanations of concepts between code snippets
    • More verbose than Examples
  • Examples
    • Clear, concise code
    • Self contained
    • May include external packages
    • Templates for more advanced usage of signac rather than instructional
  • Recipes
    • How to guides
    • Includes copy/paste components of code for advanced usages of signac

Proposed Changes

  • Tutorial
    • Ensure Tutorial covers all necessary concepts included in the ideal gas code from Examples
  • Examples
    • Remove the ideal gas example from Examples
    • Add direct links to signac-examples repo, links should accompany explanations for the purpose of each example
    • Create git submodules of examples

@bdice
Copy link
Member

bdice commented Apr 20, 2020

Just to clarify: all current content in Examples should be removed, not just the ideal gas. This will be replaced with content from signac-examples.

@atravitz atravitz self-assigned this Jul 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants