Glossary Documentation

What is a Glossary entry?

A glossary entry is a markdown file (.md) that lives anywhere inside the (top-level) glossary directory in the main repository.

An Enki glossary entry is meant to be the same as what a general glossary entry means: an alphabetical list of words relating to a specific subject, text, or dialect, with explanations; a brief dictionary.

Unlike Insights, where there's a hierarchy in place (Topic - Course - Workout - Insight), glossary can live wherever it makes sense for them to live. An object-oriented-programming.md entry could make sense under a glossary/general/object-oriented-programming.md path, for a language-agnostic definition, as well as glossary/java/object-oriented-programming.md, for a contextual definition.

Each glossary entry has a slug, which is its filename, and is used to refer to that entry. The slug should be derived from the terms the entry defines. Slugs must be lower-and-kebab-case. Any other directory under the glossary/ directory must also be a slug.

💡 The insight link is done using the path without .md, so bear that in mind: [Object-oriented Programming](https://enki.com/glossary/general/object-oriented-programming)

If you need help, try filing a pull request, and we'll comment with the necessary changes.

Examples:

• glossary/general/object-oriented-programming.md ✅
• glossary/general/Object oriented PROGRAMMING.md ❌
• glossary/general/objectOrientedProgramming.md ❌

File structure

# An H1 as title
__Markdown__ supported *content* to be shown as a modal in ~the~ app.

Glossary Example

Take glossary/general/object-oriented-programming.md:

# Object-oriented programming

Object-oriented programming (OOP) is a programming paradigm that works with real-life entities. These entities are called objects, and they have attributes and behaviors.

Let's use the common car analogy to better understand OOP.

Think of the car as the object. The model, color or age of the car are the object's attributes. Whether the engine is on, or whether it's moving are behaviors and would exist as methods.