Match the project to your task before installing it.
Developer Workflow · Public
siyuan
Developer workflow project for checking task state, code/agent collaboration, permissions, and delivery boundaries.
Check whether this project matches your task before installing it.
What it can doTask-state checks, agent collaboration boundaries, permission paths, delivery acceptance, and rollback guidanceReview the portable capability path.
Before continuingVerify in a sandboxDo not treat a preview pack as a proven local install.
GitHub snapshot45k stars2.8k forks · 105 contributors
Doramagic.ai Last verification date: 2026-06-22 Verification method: source evidence, semantic profile, public page gate, and static build acceptance.
Publication status · 2026-06-22
What is siyuan?
- siyuan supports developer collaboration, task organization, or engineering workflow management.
- Best fit: Developers organizing code tasks, agent collaboration, or engineering state into a reviewable workflow.
- Not for: Not for browser automation or workflows without clear project-state boundaries.
- Capability added to an AI workflow: Task-state checks, agent collaboration boundaries, permission paths, delivery acceptance, and rollback guidance
- First safe verification step: Verify state transitions and rollback with one non-production task first.
- Verification state: source, Quick Start, and sandbox install checks are recorded as passed.
- Top risk: May increase setup, validation, or first-run risk for the user.
- Evidence base: https://github.com/siyuan-note/siyuan, https://github.com/siyuan-note/siyuan#readme, Human Manual, Pitfall Log
01
Quick decision
Use this section to decide whether the project is worth a deeper read.Developer workflow project for checking task state, code/agent collaboration, permissions, and delivery boundaries.
45k stars · 2.8k forks
02
What it can do
Translate the upstream project into concrete capabilities the user can judge before installing.System Architecture and Workspace Model
Related topics: Block Editor (Protyle) and Card Whiteboard (Maze), Attribute View (Database) — Table, Kanban, and Gallery, Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Block Editor (Protyle) and Card Whiteboard (Maze)
Related topics: System Architecture and Workspace Model, Attribute View (Database) — Table, Kanban, and Gallery, Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Attribute View (Database) — Table, Kanban, and Gallery
Related topics: System Architecture and Workspace Model, Block Editor (Protyle) and Card Whiteboard (Maze), Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Backend Kernel, Persistence, PDF Annotations, and AI
Related topics: System Architecture and Workspace Model, Block Editor (Protyle) and Card Whiteboard (Maze), Attribute View (Database) — Table, Kanban, and Gallery
Source: https://github.com/siyuan-note/siyuan / Human Manual
Doramagic Pitfall Log
Source-linked risks stay visible on the manual page so the preview does not read like a recommendation.
Source: Doramagic discovery, validation, and Project Pack records
Sources: https://github.com/siyuan-note/siyuan, Human Manual, Project Pack evidence, and downstream validation signals.
03
Community Discussion Evidence
Project-level external discussion stays visible on the detail page, not only inside the manual.Community Discussion Evidence
12 source-linked itemsReview these external discussions before using siyuan with real data or production workflows. They are review inputs, not standalone proof that the project is production-ready.
-
01
Improve the drag-and-drop experience in the list and super block
github / github_issue
-
02
Community source 2
github / github_issue
-
03
Community source 3
github / github_issue
-
04
Community source 4
github / github_issue
-
05
Directly inserting a list block into a list item block is no longer supp
github / github_issue
-
06
Shorthands on mobile
github / github_issue
-
07
Support database filter composition
github / github_issue
-
08
Community source 8
github / github_issue
-
09
Community source 9
github / github_issue
-
10
Unable to use reference on Android mobile app
github / github_issue
-
11
Community source 11
github / github_issue
-
12
AI Agent
github / github_issue
04
How to start
Only source-backed commands are shown here. Verify them in an isolated environment first.Try the prompt first
Test the workflow without installing the upstream project.
previewRead the Human Manual
Understand inputs, outputs, limits, and failure modes.
manualTake context to your AI host
Use the compiled assets in your preferred AI environment.
contextRun sandbox verification
Confirm install commands and rollback before using a primary environment.
verifydocker run b3log/siyuanOfficial start command · https://github.com/siyuan-note/siyuan#readme · verified: yes
05
Human Manual
The English page must expose the real manual, not a short placeholder.8+ sections · Human Manual
siyuan Manual
SiYuan's authoring surface is built around two complementary concepts: the Protyle block editor for linear document authoring and the planned Maze (Card Whiteboard) for spatial, card-based...
Open the full manual- https://github.com/siyuan-note/siyuan Project Manual
- Table of Contents
- System Architecture and Workspace Model
- Related Pages
- High-Level Architecture
- Workspace and Data Repository Model
- Server and API Layer
- Data Flow and Request Lifecycle
System Architecture and Workspace Model
Related topics: Block Editor (Protyle) and Card Whiteboard (Maze), Attribute View (Database) — Table, Kanban, and Gallery, Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Block Editor (Protyle) and Card Whiteboard (Maze)
Related topics: System Architecture and Workspace Model, Attribute View (Database) — Table, Kanban, and Gallery, Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Attribute View (Database) — Table, Kanban, and Gallery
Related topics: System Architecture and Workspace Model, Block Editor (Protyle) and Card Whiteboard (Maze), Backend Kernel, Persistence, PDF Annotations, and AI
Source: https://github.com/siyuan-note/siyuan / Human Manual
Backend Kernel, Persistence, PDF Annotations, and AI
Related topics: System Architecture and Workspace Model, Block Editor (Protyle) and Card Whiteboard (Maze), Attribute View (Database) — Table, Kanban, and Gallery
Source: https://github.com/siyuan-note/siyuan / Human Manual
Doramagic Pitfall Log
Source-linked risks stay visible on the manual page so the preview does not read like a recommendation.
Source: Doramagic discovery, validation, and Project Pack records
06
AI Context Pack and portable assets
After deciding to continue, take the project context into your own AI host.Complete pack plus user-owned assets
These files are planning and verification assets for Claude Code, Codex, Gemini, Cursor, ChatGPT, and other AI hosts.
07
Preflight checks
Treat this page as a planning asset, not proof that your local environment is ready.- The manual is generated from source-linked project files and Doramagic validation signals.
- Community evidence warnings stay visible instead of being converted into marketing claims.
- This English page is indexable because the locale quality gate passed and explicit English index approval is enabled.
- Use the upstream repository as the final authority for installation commands, license, and version-specific behavior.
08
Pitfall Log and verification risks
Doramagic surfaces high-risk items before users treat a candidate capability as verified.Security or permission risk requires verification
May increase setup, validation, or first-run risk for the user.
Installation risk requires verification
May increase setup, validation, or first-run risk for the user.
Capability evidence risk requires verification
May increase setup, validation, or first-run risk for the user.
Runtime risk requires verification
May increase setup, validation, or first-run risk for the user.
Runtime risk requires verification
May increase setup, validation, or first-run risk for the user.
Maintenance risk requires verification
May increase setup, validation, or first-run risk for the user.
Security or permission risk requires verification
May increase setup, validation, or first-run risk for the user.
Security or permission risk requires verification
May increase setup, validation, or first-run risk for the user.