Skip to content

Standards for examples in documentation and tutorials #51

Description

@vws100

We should implement a standard checklist for the website or showing examples/tutorials. Once we establish this checklist/outline, we can force the AI(s) to conform.

All examples should be updated to this standard (comment/edit as necessary):

-Brief explanation of phenomena of interest
-Model definition or reference link
-Parameter Definitions
-All parameter files shown/linked
-Lattice/graph choice with parameters labelled on image(with an image of the graph)
-Lattice graph file or link
-Method(s) choice
-All execution commands listed in detail
-Plot of output and/or list of output data
-Summary of what was found and possible outlook questions
-Optional: Walkthrough video

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions