Documentation source

This directory contains the public documentation source for the DataFoundry GitHub Pages site. The site uses MkDocs Material.

• Site home: index.md
• English: English docs
• 中文：中文文档

Quick links

Goal	English	中文
Product positioning	Overview	产品概览
Local demo	Quick start	快速开始
Capability scope	Capabilities	能力全览
Web workbench	Web workbench guide	Web 工作台指南
TUI	TUI guide	TUI 指南
Data sources	Data sources guide	数据源指南
Supported sources	Supported data sources	支持的数据源
REST & config API	REST API, Configuration API	REST API, 配置 API
Agent runtime	Agent Runtime reference	Agent Runtime 参考
Architecture	Architecture overview	架构概览
Security	Security	安全说明

Documentation scope

docs/ contains public documentation and assets suitable for open-source visitors. Historical iteration notes, implementation plans, PRDs, research material, and source-sensitive content do not belong in the public docs path.

Engineering contracts, historical design notes, and internal documentation with ongoing maintenance value but not suitable for public reading stay outside this repository. When content should be public, sanitize it for users or contributors first, then add it under docs/.

Maintenance rules

• Public docs must not link to internal documentation areas.
• When adding external-facing capabilities, update both en/ and zh/ documentation.
• Example credentials must use placeholder values such as replace-with-your-key.
• Do not retain source-sensitive narrative.
• After doc changes, run npm run docs:build and npm run smoke:docs.

Local preview and GitHub Pages

Local preview:

python -m venv .venv-docs
source .venv-docs/bin/activate
python -m pip install -r requirements-docs.txt
npm run docs:dev
npm run docs:build

After pushing to main, .github/workflows/docs.yml publishes the site to GitHub Pages:

https://datagallery-lab.github.io/datafoundry/

For private repositories, enable GitHub Pages first (Settings → Pages → Source: GitHub Actions), confirm your GitHub plan allows Pages on private repos, and control public visibility in Pages settings.