Refresh system architecture diagram in README and docs#60
Merged
Conversation
Replace the legacy mermaid flowchart with a comprehensive overview that covers every current subsystem (DAG executor, triggers, scheduler, notifications, observability, all remote backends including OneDrive/ Box/WebDAV/SMB/FTP/fsspec, MCP/metrics/web UI servers, crypto, audit, FIM, config + secrets) and uses bold borders, bold labels, and thick arrows for readability. Mirror the new diagram into README.zh-TW.md / README.zh-CN.md and add a System overview section to docs/source*/architecture.rst, wired through sphinxcontrib-mermaid (added to docs/requirements.txt and all three Sphinx conf.py extension lists).
Up to standards ✅🟢 Issues
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.md/README.zh-TW.md/README.zh-CN.mdwith a comprehensive system diagram that covers every current subsystem (DAG executor, triggers, scheduler, notifications, observability, all remote backends — OneDrive / Box / WebDAV / SMB / FTP / fsspec — MCP / metrics / web UI servers, crypto, audit, FIM, config + secrets).<b>…</b>), and thick arrows (==>withlinkStyle default stroke-width:2.5px) so the graph reads well at README zoom.docs/source/architecture.rst,docs/source.zh-TW/architecture.rst, anddocs/source.zh-CN/architecture.rst; wire it throughsphinxcontrib-mermaid(added todocs/requirements.txtand all three Sphinxconf.pyextension lists).Test plan
README.mdrenders the new mermaid diagram on GitHub (verify subgraph color classes and bold arrows).README.zh-TW.mdandREADME.zh-CN.mdrender with the translated subgraph labels.pip install -r docs/requirements.txt && sphinx-build -b html docs/source docs/_build/html) succeeds and the System overview section renders the mermaid diagram for each language.ruff check automation_file/ tests/andpython -m pytest tests/ -vstill pass (docs-only change, no code).