Topic Documentation

What is a Topic?

The Topic is the most abstract collection of knowledge in the Enki curriculum. A topic usually refers to a technology or subject that encapsulates its Courses, Workouts and Insights. Topic examples include Docker, Python and React.

Topics refer to the top-most folders in the folder hierarchy of the content. Within these folders, the README.md is considered the manifest and includes all its metadata.

Similar to all other content types, in the content hierarchy, we specify folders with a readable slug.

Check out this topic folder and this topic manifest examples.

One important caveat to keep in mind is that topics must have only one CORE course. (check out the Course Documentation for details on this)

Fields Definitions

Name

This field is shown in the app together with any other more-granular content piece (e.g. Insights, Workouts). It needs to be short- less than 20 characters max.

Description

This field is shown in the app when the user subscribes to new topics. It can be a little longer, but should still remain under 100 characters.

Color

This is the main colour of a topic and it helps to visually identify any content item in the application. The field must refer to a HEX colour.

When creating the colour, you should convert the HEX value to HSV. In the new HSV value, you should make sure that the saturation is equal to 0.35 and the value is equal to 1. Then, you can convert it back to a HEX value and add it to the color field.

In case you forget to follow the steps above, there is an automated rule which will perform all the checks and return the correct HEX value to be used.

Icon

Similar to the colour, the icon help with the visual identification of topics. It can link to a png image, preferably of smaller dimensions.

Language

This field helps with the syntax highlighting provided in the app for all code snippets within insights of this topic. The accepted values can be found here

Topic Example

A topic's README file looks like this:

name: Python

description: One of the easiest languages to learn. But we go advanced too.

color: 79A551

icon: https://img.enkipro.com/2cec1024be8b9d18d1e485fab441ce9c.png

language: py