Developer documentation

How does the website work?

• Any maintainer/developer commits some changes to Github
• Github workflow runs build.py script
• build.py builds all HTML pages only by their front-matter
• Jekyll builds the pages based on layout field in the front matter, layouts are written in _layouts folder
• Github workflow finishes and Github pages hosts the static HTML website

The library

The core library serves the core JSON files and takes care of some error handling and merging data togother.

Here is a TODO list:

• Error handling
• Add more data checking on the files with clear error messages

Languages and Translation

Here is the main translations file: translations.json.

The list of languages exist in utils.py, it should be moved by devs to build.py. The first language in that list is the primary language.

The build script will copy every language to _data/TWO_LETTER_CODE directory as .yml.

For any file in _data folder in jeykll, you can access it by site.data.FILE_NAME.ANY_FIELD, and this is the way will be used for translations like this:

{{site.data[page.lang].text_name}}

URLs based on language

Here is an example:

{% if page.lang != site.data.build.primary_lang %}/{{ page.lang }}/{% endif %}/olympaids/boi/2024

Future projects

You might check the original TODO list, but it’s up to your laziness if you will do them.

Additional guides

• /debug: Website debugging URL
• /data: Data guide for maintainers
• You might check the other private repos in the organization which has some assisting tools