diff --git a/docs/README.md b/docs/README.md index e667fa1b61..01d907fa25 100644 --- a/docs/README.md +++ b/docs/README.md @@ -67,6 +67,7 @@ a longer onboarding path. ## Project And Community +- [Community entry points](community.md) ([中文](community.zh-CN.md)) - [Current technical directions](project/technical-directions.md) - [Open strategy reviews](community/open-strategy-reviews.md) ([中文](community/open-strategy-reviews.zh-CN.md)) diff --git a/docs/community.md b/docs/community.md new file mode 100644 index 0000000000..670c5753c1 --- /dev/null +++ b/docs/community.md @@ -0,0 +1,70 @@ +# LoopX Community + +> [中文](community.zh-CN.md) + +Use this page to choose the public channel that matches what you want to do. +Chat is useful for exploration, but reproducible bugs, decisions, and durable +evidence should return to GitHub. + +## Discuss And Connect + +- [Pinned GitHub Discussion](https://github.com/loopx-project/loopx/discussions/2851): + current technical directions, known limitations, and community discussion. +- [Discord](https://discord.gg/XmGgQyCFZd): informal onboarding, workflow + comparison, and show-and-tell conversation. +- [Lark developer group](assets/loopx-lark-developer-group.png): scan the QR + code to join directly. +- [WeChat contact](assets/loopx-wechat-contact.png): add `huangrt00` and mention + LoopX in the friend request. + +For channel ownership, support boundaries, and official publication sources, +see [Support](../.github/SUPPORT.md). + +## Report, Request, Or Contribute + +Choose the narrowest issue form for your public-safe report: + +- [Bug report](https://github.com/loopx-project/loopx/issues/new?template=bug_report.yml) + for reproducible incorrect or unexpected behavior. +- [Feature request](https://github.com/loopx-project/loopx/issues/new?template=feature_request.yml) + for a concrete product or documentation improvement. +- [First-run feedback](https://github.com/loopx-project/loopx/issues/new?template=first_run.yml) + for optional feedback after installing and running LoopX once. +- [Show and Tell / Adoption](https://github.com/loopx-project/loopx/issues/new?template=show_and_tell.yml) + for a public-safe workflow, result, integration, or adoption story. +- [Usage story](https://github.com/loopx-project/loopx/issues/new?template=usage_story.yml) + for a public report from a LoopX run lasting hours, days, or longer. +- [Contributor task](https://github.com/loopx-project/loopx/issues/new?template=contributor-task.yml) + to claim, propose, or discuss repository-safe work. + +Before opening a contribution, read [Contributing](../CONTRIBUTING.md) and the +[public/private boundary](public-private-boundary.md). Never publish +credentials, private project context, raw agent sessions, internal links, or +local runtime state. + +## Share A Showcase + +Start with the [Showcase catalog](showcases/README.md), then use one of these +prompts: + +- [Show and Tell / Adoption](https://github.com/loopx-project/loopx/issues/new?template=show_and_tell.yml): + describe what really ran, how LoopX was used, the observed outcome and public + evidence, remaining limitations, and reproducible artifacts when available. +- [Usage story](https://github.com/loopx-project/loopx/issues/new?template=usage_story.yml): + record the run duration, capabilities exercised, public-safe recovery story, + and the outcome LoopX helped complete. + +Showcase entries keep evidence boundaries explicit. A report may be useful +before it is independently reproduced, but its status must say what remains +user-reported, assisted, experimental, or unverified. + +## Explore The Ecosystem + +- [Ecosystem adoption and derivatives catalog](community/ecosystem-adoption.md): + maintainer-curated public evidence about integrations, mechanism reuse, + proposals, learning resources, and derivatives. +- [ADOPTERS](../ADOPTERS.md): voluntary, self-attested adoption entries from + projects and users. + +These are different evidence surfaces. A catalog entry records observable +public evidence; it does not imply endorsement or production deployment. diff --git a/docs/community.zh-CN.md b/docs/community.zh-CN.md new file mode 100644 index 0000000000..85beb5009f --- /dev/null +++ b/docs/community.zh-CN.md @@ -0,0 +1,60 @@ +# LoopX 社区 + +> [English](community.md) + +请按你想完成的事选择对应公开渠道。即时交流适合探索，但可复现的 bug、 +决定和持久证据应回到 GitHub。 + +## 讨论与联系 + +- [置顶 GitHub Discussion](https://github.com/loopx-project/loopx/discussions/2851)： + 当前技术方向、已知限制与社区讨论。 +- [Discord](https://discord.gg/XmGgQyCFZd)：非正式 onboarding、工作流比较与 + show-and-tell 交流。 +- [飞书开发者群](assets/loopx-lark-developer-group.png)：扫码直接加入。 +- [微信联系人](assets/loopx-wechat-contact.png)：添加 `huangrt00`，好友申请备注 + LoopX。 + +渠道分工、支持边界和官方发布源见 [Support](../.github/SUPPORT.md)。 + +## 报告、建议与贡献 + +请为公开安全的内容选择最精确的 Issue 表单： + +- [Bug 报告](https://github.com/loopx-project/loopx/issues/new?template=bug_report.yml)： + 可复现的错误或意外行为。 +- [功能建议](https://github.com/loopx-project/loopx/issues/new?template=feature_request.yml)： + 具体的产品或文档改进。 +- [首次运行反馈](https://github.com/loopx-project/loopx/issues/new?template=first_run.yml)： + 安装并首次运行 LoopX 后的可选反馈。 +- [Show and Tell / 采用故事](https://github.com/loopx-project/loopx/issues/new?template=show_and_tell.yml)： + 公开安全的工作流、结果、集成或采用故事。 +- [使用故事](https://github.com/loopx-project/loopx/issues/new?template=usage_story.yml)： + 持续数小时、数天或更久的 LoopX 运行报告。 +- [贡献者任务](https://github.com/loopx-project/loopx/issues/new?template=contributor-task.yml)： + 认领、提议或讨论可公开的仓库工作。 + +提交贡献前，请阅读 [Contributing](../CONTRIBUTING.md) 和 +[公开/私有边界](public-private-boundary.md)。不要发布凭据、私有项目上下文、 +原始 Agent 会话、内部链接或本地运行时状态。 + +## 分享 Showcase + +先阅读 [Showcase 清单](showcases/README.md)，再选择对应的提示： + +- [Show and Tell / 采用故事](https://github.com/loopx-project/loopx/issues/new?template=show_and_tell.yml)： + 说明真实运行了什么、LoopX 如何参与、可观察结果与公开证据、剩余限制， + 以及可用时的复现材料。 +- [使用故事](https://github.com/loopx-project/loopx/issues/new?template=usage_story.yml)： + 记录运行时长、所使用能力、公开安全的恢复过程，以及 LoopX 帮助完成的结果。 + +Showcase 条目必须明确证据边界。即使尚未独立复现，报告仍可能有价值； +但状态必须说明哪些内容尚属用户自述、协助运行、实验性结果或未验证内容。 + +## 查看生态 + +- [生态采用与衍生清单](community/ecosystem-adoption.zh-CN.md)： + 维护者根据公开证据整理的集成、机制借鉴、提案、学习资源与衍生实现。 +- [ADOPTERS](../ADOPTERS.md)：由项目或用户自愿提交的采用登记。 + +它们是不同的证据表面。清单条目只记录可观察的公开证据，不代表背书或生产环境部署。 diff --git a/docs/index.md b/docs/index.md index 8a7524d0dc..d2ce1467d3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -88,3 +88,9 @@ ignored and private. - [Public/private boundary](public-private-boundary.md) - [Status data contract](status-data-contract.md) - [Release readiness](product/release-readiness.md) + +## Join And Contribute + +Use the [community entry-point page](community.md) ([中文](community.zh-CN.md)) +to choose between the pinned discussion, Discord, Lark, WeChat, focused issue +forms, showcase prompts, and the public ecosystem catalog. diff --git a/examples/docs-governance-smoke.py b/examples/docs-governance-smoke.py index 3402e469d4..1ed894c6e5 100644 --- a/examples/docs-governance-smoke.py +++ b/examples/docs-governance-smoke.py @@ -14,6 +14,8 @@ ROOT_DOCS = { "README.md", "architecture.md", + "community.md", + "community.zh-CN.md", "heartbeat-automation-prompt.md", "index.md", "integration.md", @@ -79,12 +81,17 @@ # docs/index.md .md targets that stay outside mkdocs nav on purpose. # Prefer fixing mkdocs.yaml nav for public hosted entry points instead. -DOCS_INDEX_NAV_ALLOWLIST: dict[str, str] = {} +DOCS_INDEX_NAV_ALLOWLIST: dict[str, str] = { + "community.md": "hosted community entry linked below the first screen; top-nav promotion remains owner-reviewed", + "community.zh-CN.md": "zh locale sibling for the hosted community entry", +} # docs/README.md catalog .md targets that stay outside mkdocs top nav on purpose. DOCS_CATALOG_NAV_ALLOWLIST = { "architecture/README.md": "architecture tree index; RFCs linked from Reference nav", "archive/README.md": "excluded from hosted site via exclude_docs", + "community.md": "community entry linked from the hosted index below the first screen", + "community.zh-CN.md": "zh locale sibling for the community entry", "community/open-strategy-reviews.md": "community process; catalog-only entry", "community/open-strategy-reviews.zh-CN.md": "zh locale sibling for community reviews", "development/contributor-tasks.md": "contributor board; not a hosted docs primary page",