General fast way to understand the architecture and workflows is to follow this docs workflow:
ADR -> tools -> workflow directoriesStep 1. Setup Your Environment¶
Run this scripts in your GNU/Linux terminal:
bash ./tools/scripts/configure_repo.sh(in development) Configure JupyterLab for working with the files in this repo.
Step 2. Read Most Important Materials¶
Arthicture¶
“A Multi-Layered AI System Architecture” to understand the repo structure.
Series on how we work with Git in
/tools/docs/git/.ADRs in
/architecture/adrto understand our choices and our stack.
Working with the Repository¶
Your AI Tools¶
“The aidx Industrial AI Orchestration Framework” - the high level description of our agentic approach.
“General Purpose (Abstract Synthesis) vs Agentic (Instruction Adherence) Models” - what models to use for different types of tasks, see the aidx description above for more details.
Keep Your Work Clean¶
This repository contains the very different types of files - docs, configs, code. Before commit and push to the repository all you have done must be tested and validated for not breaking what is already built, like cross-links, scripts for internal use, etc.
The most of validation is done for you by automatic checks (or will be done for you as soon as possible) via pre-commit hooks and GitHub actions. But some validation should be done by you manually - it concerns publishing new .ipynb docs in the first hand.
Before commiting, run the MyST server locally from your terminal
uv run myst startand:
analyze the stdout messages for any errors,
take a look at your new articles or modified files by opening
localhost:3000in your web browser.
Fix what you can fix or ask for help from the peers before Pull Request.