Course Definition Reference

slug

string

A unique URL-friendly identifier for your course. Example: redis.

name

string

The name of your course. Example: Build your own Redis.

short_name

string

A short name for your course. Example: Redis.

release_status

string

The release status of your course. Accepted values: alpha, beta, live.

description_md

string

A markdown description for your course. 25-50 words.

short_description_md

string

A short description of your course, < 15 words.

completion_percentage

integer

The percentage of users who complete this course. Set to 5% if we don’t have data yet.

languages

array

Show item properties

slug

string

Slug for the language. Example: python. Full list of languages available here.

starter_repository_url

string

URL to the starter repository for this language. Example: https://github.com/codecrafters-io/redis-starter-ruby

marketing

object

Show properties

difficulty

string

The difficulty of the course. Accepted values: easy, medium, hard.

sample_extension_idea_title

string

A title for the sample extension idea. Example: Geospatial Queries

sample_extension_idea_description

string

A description for the sample extension idea. Example: A Redis server that can respond to geospatial queries

testimonials

array

Show item properties

author_name

string

author_description

string

author_avatar

string

link

string

text

string

stages

array

Show item properties

slug

string

A unique identifier for this stage. Your tester will reference this value. Example: init

name

string

The name of this stage. Example: Respond to PING

description_md

string

A markdown description for this stage, rendered in the ‘Your Task’ card.

difficulty

string

A difficulty rating for this stage, from the perspective of a proficient programmer.

very_easy: <5m
easy: 5-10m
medium: 30m-1h
hard: >1h

marketing_md

string

A short markdown description of this stage, used in the course overview page.

tester_source_code_url

string

Link to the source code for the test cases of this stage. Optional.

Contributors

Adding Language Support

Authoring Concepts

Authoring Challenges

Course Definition Reference