Skip to content

Experimental Recipe

Our branch protections will require a PR for now, but that PR will be approved without review by any maintainer.

How To Create a New Practice

Goal: Create a practice.

Steps

  1. Figure out the right place for your practice in our tree.
  2. Create a new folder with the URL for your practice. In it, create index.md with these contents:
    markdown
    ---
    phase: new
    ---
    # How To XXXX
    
    **Goal:** .
    
    <Steps>
    
    1. do: something
    
    </Steps>
  3. fill in the title and the goal.
  4. fill in the steps. The steps must be an ordered list. Each item must start with the step kind and a colon, then the content for that step. You can also define subgoals by using headers. This example shows each step kind.
    markdown
    1. do: [instruction to person]
    1. ask: [question?]
     * [option 1]:
     1. do: continue recipe here...
     * [option 2]:
     1. do: continue recipe here...
    1. fail: [failure reason]
    1. wait: [how long or what event to wait for]
    1. achieve: [goal's slug]
    
    ## [slug]: [Description]
    1. do: more recipe...
  5. Make sure that there is whitespace around the markdown within the <Steps> tags.
  6. Preview your changes either by running locally (npm run start) or by pushing and viewing a preview.
  7. do you see errors shown on the page, before the steps?
    yes:
    1. Fix and try again.
    no:
    1. Send a PR and notify a maintainer that there's a new recipe. They will approve without review, unless you specifically ask them for one.
  8. Done!