You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feature flags for optional systems such as encrypted mailbox, Feishu bridge, GitHub App integration, and terminal supervisor features
Migration strategy
Do not big-bang all docs in one PR.
Decision pass
Decide whether generated .md files remain tracked. Recommendation: keep generated .md tracked for GitHub/npm readability, but add a generated header and CI drift check.
Decide where Markrun lives in cnb: vendored script, submodule path, npm package, or dev-only checkout. Avoid making normal cnb users install extra tooling just to read docs.
Decide cnb-side content owner.
Minimal pilot
Convert only README.md and README_zh.md first.
Keep current rendered output semantically identical except for an explicit generated header if adopted.
Add a local check command that rebuilds and fails on drift.
Core docs migration
Add .github/CONTRIBUTING.md and CLAUDE.md once README parity is stable.
Extract shared fragments only when there is real duplication.
Extended docs
Consider CHANGELOG.md and SECURITY.md last. These may need stricter human review and may not fully benefit from templating.
Markrun-side dependencies to check before implementation
Breadboard Markrun issues that affect safe adoption:
Summary
Track the cnb-side adoption of Markrun as the single source of truth for cnb documentation.
The cross-project proposal lives in Breadboard: https://github.com/ApolloZhangOnGithub/Breadboard/issues/11
This issue exists in the cnb repository because the actual content migration, review, CI policy, and generated-file rules belong to cnb.
Owner split
ritchieowns compatibility work on the Markrun side, per Breadboard Multi-Agent 框架研究:Google ADK — 分层 Agent 组合与三种通信机制 #11._markrun.ymlandfragments.mrtemplate library support.Proposed migration target
Use Markrun sources for the cnb documentation suite:
Shared data should include at minimum:
Migration strategy
Do not big-bang all docs in one PR.
.mdfiles remain tracked. Recommendation: keep generated.mdtracked for GitHub/npm readability, but add a generated header and CI drift check.README.mdandREADME_zh.mdfirst..github/CONTRIBUTING.mdandCLAUDE.mdonce README parity is stable.CHANGELOG.mdandSECURITY.mdlast. These may need stricter human review and may not fully benefit from templating.Markrun-side dependencies to check before implementation
Breadboard Markrun issues that affect safe adoption:
Acceptance criteria
"0.10"remain strings.Non-goals