Welcome to Optolith Static Source Data Documentation!
This documentation will cover a lot of questions you may have. Let's dive in!
- Introduction
- There are some Prerequisites you need to meet before you can work on Optolith – but don’t worry, it’s neither much nor difficult!
- Project Management describes where you can find project management resources and how you can integrate yourself to make sure others know about your work.
- Git Workflow is a tutorial for Git and how we use Git. You don't need to have any experience with Git or coding in general, but if you have, you'll get through it way faster!
- Setting Up Visual Studio Code ... there's nothing else to say what it covers.
- Insertion Workflow is a guide on how to start inserting new content, what you need to know and watch out for.
- Translation Workflow is a guide on how to start translating existing content, what you need to know and watch out for.
- Testing tells you how you can test your work.
- Conventions is a list of "coding" conventions you should follow.
- Markdown is a small guide for text formatting in Optolith, which uses Markdown syntax to style text. You'll get an overview as well as some do's and dont's.
- Index of Types is an overview of all available entities and subschemas, where you can check out specific ones and see what each property is used for.
- Using the database in your own project gives you some hints and recommendations on how to use the Optolith database in your own projects.