Feature/docs

[416rehman]

What does this PR do?
Adds docs as github pages

Related issues

How to test
visit https://416rehman.github.io/DeepZero/en/

Checklist

• [ x ] ruff check . and ruff format --check . pass
• [ x ] bandit -ll -ii -c pyproject.toml -r . passes
• [ x ] pytest passes
• [ x ] Tests added/updated if needed

[Copilot]

Pull request overview

Adds a Jekyll-based, multi-language documentation site under docs/ and deploys it to GitHub Pages, while updating repository meta/docs to point users to the new site.

Changes:

• Introduce localized documentation pages (EN/FR/ZH-CN/ES/RU/JA) plus shared layout, styling, and JS for theme + language switching.
• Add a GitHub Pages deployment workflow for the docs/ site and ignore Jekyll build artifacts.
• Simplify READMEs and link them to the new documentation site; update contributing guidelines for doc translations.

Reviewed changes

Copilot reviewed 72 out of 81 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
docs/zh-CN/system/state-persistence.md	Adds Simplified Chinese state persistence documentation.
docs/zh-CN/system/repo-structure.md	Adds Simplified Chinese repository structure documentation.
docs/zh-CN/reference/pipeline-yaml.md	Adds Simplified Chinese pipeline YAML reference.
docs/zh-CN/reference/included-pipeline.md	Adds Simplified Chinese included pipeline reference.
docs/zh-CN/reference/cli.md	Adds Simplified Chinese CLI reference.
docs/zh-CN/overview/quickstart.md	Adds Simplified Chinese quickstart.
docs/zh-CN/overview/architecture.md	Adds Simplified Chinese architecture overview.
docs/zh-CN/index.html	Adds Simplified Chinese docs landing page.
docs/zh-CN/extensibility/built-in.md	Adds Simplified Chinese built-in processors documentation.
docs/zh-CN/extensibility/building-custom.md	Adds Simplified Chinese custom processor guide.
docs/serve.sh	Adds a Docker-based local Jekyll serve helper script.
docs/ru/system/state-persistence.md	Adds Russian state persistence documentation.
docs/ru/system/repo-structure.md	Adds Russian repository structure documentation.
docs/ru/reference/pipeline-yaml.md	Adds Russian pipeline YAML reference.
docs/ru/reference/included-pipeline.md	Adds Russian included pipeline reference.
docs/ru/reference/cli.md	Adds Russian CLI reference.
docs/ru/overview/quickstart.md	Adds Russian quickstart.
docs/ru/overview/architecture.md	Adds Russian architecture overview.
docs/ru/index.html	Adds Russian docs landing page.
docs/ru/extensibility/built-in.md	Adds Russian built-in processors documentation.
docs/ru/extensibility/building-custom.md	Adds Russian custom processor guide.
docs/ja/system/state-persistence.md	Adds Japanese state persistence documentation.
docs/ja/system/repo-structure.md	Adds Japanese repository structure documentation.
docs/ja/reference/pipeline-yaml.md	Adds Japanese pipeline YAML reference.
docs/ja/reference/included-pipeline.md	Adds Japanese included pipeline reference.
docs/ja/reference/cli.md	Adds Japanese CLI reference.
docs/ja/overview/quickstart.md	Adds Japanese quickstart.
docs/ja/overview/architecture.md	Adds Japanese architecture overview.
docs/ja/index.html	Adds Japanese docs landing page.
docs/ja/extensibility/built-in.md	Adds Japanese built-in processors documentation.
docs/ja/extensibility/building-custom.md	Adds Japanese custom processor guide.
docs/index.html	Adds root docs redirect page with language auto-detection.
docs/fr/system/state-persistence.md	Adds French state persistence documentation.
docs/fr/system/repo-structure.md	Adds French repository structure documentation.
docs/fr/reference/pipeline-yaml.md	Adds French pipeline YAML reference.
docs/fr/reference/included-pipeline.md	Adds French included pipeline reference.
docs/fr/reference/cli.md	Adds French CLI reference.
docs/fr/overview/quickstart.md	Adds French quickstart.
docs/fr/overview/architecture.md	Adds French architecture overview.
docs/fr/index.html	Adds French docs landing page.
docs/fr/extensibility/built-in.md	Adds French built-in processors documentation.
docs/fr/extensibility/building-custom.md	Adds French custom processor guide.
docs/es/system/state-persistence.md	Adds Spanish state persistence documentation.
docs/es/system/repo-structure.md	Adds Spanish repository structure documentation.
docs/es/reference/pipeline-yaml.md	Adds Spanish pipeline YAML reference.
docs/es/reference/included-pipeline.md	Adds Spanish included pipeline reference.
docs/es/reference/cli.md	Adds Spanish CLI reference.
docs/es/overview/quickstart.md	Adds Spanish quickstart.
docs/es/overview/architecture.md	Adds Spanish architecture overview.
docs/es/index.html	Adds Spanish docs landing page.
docs/es/extensibility/built-in.md	Adds Spanish built-in processors documentation.
docs/es/extensibility/building-custom.md	Adds Spanish custom processor guide.
docs/en/system/state-persistence.md	Adds English state persistence documentation.
docs/en/system/repo-structure.md	Adds English repository structure documentation.
docs/en/reference/pipeline-yaml.md	Adds English pipeline YAML reference.
docs/en/reference/included-pipeline.md	Adds English included pipeline reference.
docs/en/reference/cli.md	Adds English CLI reference.
docs/en/overview/quickstart.md	Adds English quickstart.
docs/en/overview/architecture.md	Adds English architecture overview.
docs/en/index.html	Adds English docs landing page.
docs/en/extensibility/built-in.md	Adds English built-in processors documentation.
docs/en/extensibility/building-custom.md	Adds English custom processor guide.
docs/assets/js/script.js	Adds frontend behavior (theme + language switching + mobile sidebar).
docs/assets/css/style.css	Adds site styling for docs UI and theming.
docs/_layouts/default.html	Adds shared Jekyll layout with sidebar nav, language dropdown, SEO tags.
docs/_config.yml	Adds Jekyll site configuration (title/description/url).
README.zh-CN.md	Adds Simplified Chinese README pointing to docs and summarizing the project.
README.md	Simplifies English README and points readers to the docs site.
README.fr.md	Adds French README pointing to docs and summarizing the project.
CONTRIBUTING.md	Adds documentation/translation contribution requirements and locale parity expectations.
.gitignore	Ignores Jekyll build artifacts and caches.
.github/workflows/pages.yml	Adds GitHub Pages workflow to build and deploy the docs/ site.
.github/workflows/ci.yml	Fixes editable install quoting in CI step.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

<html lang="en"> is hard-coded, so every locale page will declare English to browsers/screen readers/search engines. Consider setting lang dynamically based on the current locale (e.g. from page.url/current_lang, or via a lang: front-matter field).

Suggested change

	<html lang="en">
	<html lang="{{ page.lang | default: site.lang | default: 'en' }}">

[Copilot]

Canonical/OG/Twitter URLs are built as {{ site.url }}{{ page.url }}, which drops site.baseurl when Pages builds with a project base path (typical for repo Pages). This can generate incorrect canonical/social URLs. Prefer {{ page.url | absolute_url }} (or {{ page.url | relative_url | prepend: site.url }}) so baseurl is included consistently.

[Copilot]

hreflang for Simplified Chinese is set to zh, but the actual locale path is zh-CN. For SEO correctness, align the hreflang value with the locale you serve (e.g. zh-CN, or zh-Hans if that’s what you intend).

[Copilot]

The page includes an immediate meta refresh to en/ (content="0; url=en/") as well as JS-based locale detection. The meta refresh can preempt the JS and effectively force English for many clients. If you want JS-based language selection, consider removing the meta refresh or moving it into a <noscript> block / adding a delay so JS can run first.

[Copilot]

The Execution Flags (run) table is missing its header row (it starts directly with the separator | --------- | ----------- |). Markdown tables require a header row like | Flag | Description | before the separator, otherwise rendering will be broken/inconsistent.

[Copilot]

The Quickstart documentation link points to https://416rehman.github.io/DeepZero/overview/quickstart.html, but the docs are served under language-prefixed paths (e.g. /en/overview/quickstart.html). This URL will 404 unless you have a separate redirect set up. Update the link to the correct language path (or to the docs root if you intend to rely on the language auto-redirect).

Suggested change

	For detailed setup instructions and example corpora, see the [Quickstart Documentation](https://416rehman.github.io/DeepZero/overview/quickstart.html).
	For detailed setup instructions and example corpora, see the [Quickstart Documentation](https://416rehman.github.io/DeepZero/en/overview/quickstart.html).

[Copilot]

This Quickstart link targets /DeepZero/overview/quickstart.html, but the published docs live under locale directories (e.g. /DeepZero/zh-CN/overview/quickstart.html or /DeepZero/en/overview/quickstart.html). As written, the link will 404. Please update it to the correct locale path.

Suggested change

	有关详细的设置说明和示例语料库，请参阅[快速开始文档](https://416rehman.github.io/DeepZero/overview/quickstart.html)。
	有关详细的设置说明和示例语料库，请参阅[快速开始文档](https://416rehman.github.io/DeepZero/zh-CN/overview/quickstart.html)。

[Copilot]

This Quickstart link targets /DeepZero/overview/quickstart.html, but the published docs live under locale directories (e.g. /DeepZero/fr/overview/quickstart.html or /DeepZero/en/overview/quickstart.html). As written, the link will 404. Please update it to the correct locale path.

Suggested change

	Pour des instructions de configuration détaillées et des exemples de corpus, consultez la [Documentation de Démarrage Rapide](https://416rehman.github.io/DeepZero/overview/quickstart.html).
	Pour des instructions de configuration détaillées et des exemples de corpus, consultez la [Documentation de Démarrage Rapide](https://416rehman.github.io/DeepZero/fr/overview/quickstart.html).