Getting Started Guide

Getting Started

Hello! Welcome to Enki's open-source developer learning materials. These materials power the Enki ecosystem and are the combined efforts of many developers worldwide. You can use these materials to teach or train developers, or you can use our system to view them as a curriculum.

How to Write Content

You can find general guidelines on how to approach writing content for the Enki App. Depending on the target audience and also being bound to a mobile presentation platform, writing content has its nuances. Check out the Content Writing Guidelines for more details.

How the Curriculum is Organized

First, take a look at the List of Topics.

Each Topic has a top-level folder in the repository. Under each of these Topics, you can find Subtopics or Courses (same thing), each having its own Workouts. Under each workout is some number of Insights. Each workout ideally has around 5 Insights.

Here's a top-down view of the curriculum structure:

Topic:

• Course 1
  • Workout 1
    • Insight 1
    • Insight 2
    • ...
  • ...
• Course 2
• ...

Writing open-source content

You can also help extend and write the curriculum! There are a few ways to contribute:

Add a Workout: Workout Documentation

Add an Insight: Insight Documentation

Work on an existing plan: Proposed Topics

Plan a course: Creating a Course Guide

Add a tip: Tips and Tricks

Work on an Issue: Issue Process