Documentation Conventions

Although the documentation is written with simplicity in mind, a few conventions must be understood to utilize its full potential.

Variables

Variables are through the documentation marked as {variable-name}. The casing in the bracket is crucial to on how to replaced value should look like.

{project-name}

✅ Correct
runeterra

❌ Incorrect
Runeterra
RUNETERRA

{ProjectName}

✅ Correct
Runeterra

❌ Incorrect
runeterra
RUNETERRA

{PROJECT_NAME}

✅ Correct
RUNETERRA

❌ Incorrect
runeterra
Runeterra

---

That's it! Feel free to roam the documentation using the navigation on the top.