How epam/ai-dial works
Project type and purpose
• This repository is a documentation website for the DIAL platform.
• It uses a static-site generator (Docusaurus + Quarto transformers in Node.js/React) to turn markdown and Jupyter notebooks into a browsable site.
• The docs cover architecture, tutorials, examples (dial-cookbook, dial-docker-compose), and link out to other DIAL micro-repos (core, SDK, chat UI, adapters).
File structure
• Top-level config and metadata:
• .github/ (GitHub Actions workflows for CI/CD)
• package.json, package-lock.json, babel.config.js, docusaurus.config.js, sidebars.js (SSG and build configs)
• .quarto.yml (Quarto site config)
• Content sources:
• dial-cookbook/, dial-docker-compose/, dial-sdk/ (submodules supplying code samples, Docker-Compose examples, SDK reference)
• Build assets:
• src/ (custom scripts & markdown transformers)
• static/ (images, robots.txt, CNAME, metaschema.json)
• src/css (custom site styling)
• CI & release:
• .github/workflows/pr.yml (build & lint on PR)
• .github/workflows/release.yml (deploy on push to main)
README for additional insights
• Confirms this is the “DIAL Documentation” site.
• Points to an “Architecture Overview” doc under docs/platform/0.architecture-and-concepts.
• Documents how to run things locally, use Helm charts, and links out to all related DIAL repos.