Skip to content

Commit fd408ee

Browse files
huangruitenghuangruiteng
authored
docs: establish external LoopX brand guidance and adopters
Public documentation only: external brand-use guidance for open-source projects, commercial companies, and users, plus voluntary ADOPTERS contribution mechanics. Local canary and all required GitHub checks passed.
1 parent 76059cb commit fd408ee

11 files changed

Lines changed: 456 additions & 2 deletions

‎ADOPTERS.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# LoopX Adopters
2+
3+
This is a voluntary, self-attested directory of projects and users who choose
4+
to use LoopX. An entry records a public relationship; it is not a testimonial,
5+
certification, security review, support commitment, or maintainer endorsement.
6+
7+
The maintainer-observed [Ecosystem Adoption](docs/community/ecosystem-adoption.md)
8+
inventory remains a separate evidence surface. `ADOPTERS.md` is for people and
9+
projects to describe their own use, including a planned or experimental trial.
10+
11+
## Current Directory
12+
13+
There are no public self-attested entries yet. This empty list is intentional:
14+
projects and users should add themselves only when they want to be named.
15+
16+
| Project or user | Public link | Adoption mode | Status | Public note | Last verified |
17+
| --- | --- | --- | --- | --- | --- |
18+
19+
### Adoption modes
20+
21+
- **Integration** — calls LoopX CLI or contracts from a real project workflow.
22+
- **Workflow** — uses LoopX to govern a recurring or long-running work lane.
23+
- **Learning** — follows LoopX contracts in a tutorial, book, course, or study.
24+
- **Derivative** — builds a fork, package, adapter, or adjacent tool inspired by
25+
LoopX and identifies the relationship clearly.
26+
27+
Use `active`, `experimental`, `planned`, or `paused` for status. A user may
28+
identify themselves by a public handle or project name; no legal name or private
29+
organization detail is required.
30+
31+
## Add Or Update An Entry
32+
33+
Project and user owners may add, update, or remove their own row through a small
34+
pull request. No private account, internal deployment, credential, customer
35+
detail, raw transcript, or unverifiable performance claim belongs here.
36+
37+
Copy this shape and replace only the fields you can support publicly:
38+
39+
```md
40+
| Project or user | Public link | Integration / Workflow / Learning / Derivative | active / experimental / planned / paused | One sentence describing the public use and boundary | YYYY-MM-DD |
41+
```
42+
43+
The contributor should:
44+
45+
1. use a public project, profile, issue, pull request, release, or documentation
46+
link;
47+
2. state what is actually used and whether the entry is planned or running;
48+
3. avoid claiming LoopX caused an outcome unless the public evidence supports
49+
that claim;
50+
4. run the repository's public/private boundary and documentation checks; and
51+
5. sign the commit according to [`CONTRIBUTING.md`](CONTRIBUTING.md).
52+
53+
This is intentionally a narrow public-doc change. A collaborator with merge
54+
permission may self-merge a clean entry after the required checks pass; a
55+
project or user without that permission can submit the same focused PR for the
56+
normal maintainer merge path. Adding a row never grants repository, product,
57+
support, or endorsement authority.
58+
59+
Owners can request removal at any time. Maintainers may ask for a stale link to
60+
be updated or remove a confusing, private, or unsupported claim while keeping
61+
the change history public.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -652,6 +652,8 @@ deeper documents and versioned protocols.
652652
- [Authors and Contributors](docs/project/authors.md)
653653
- [Project History](docs/project/history.md)
654654
- [Name and Marks](docs/project/trademarks.md)
655+
- [Brand Guide for External Use](docs/project/brand-guide.md): how projects and companies may reference LoopX, its integrations, and its artwork
656+
- [ADOPTERS](ADOPTERS.md): voluntary self-attested adoption directory
655657
- [Ecosystem Adoption](docs/community/ecosystem-adoption.md) - integrations,
656658
sampling, and derivatives we observe and track
657659

‎README.zh-CN.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,8 @@ LoopX 当前有三个活跃战略计划和一个架构与研究孵化器。这
583583
- [Authors and Contributors](docs/project/authors.md)
584584
- [Project History](docs/project/history.md)
585585
- [Name and Marks](docs/project/trademarks.md)
586+
- [对外品牌使用指南](docs/project/brand-guide.zh-CN.md)：开源项目、公司和用户如何引用 LoopX、描述集成并使用图形素材
587+
- [ADOPTERS](ADOPTERS.md)：项目与用户自愿维护的采用目录
586588
- [生态采用清单](docs/community/ecosystem-adoption.zh-CN.md) - 我们观察并持续追踪的
587589
真实集成、采样借鉴与衍生周边
588590

‎docs/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ a longer onboarding path.
7777
- [Licensing and the v0.4.8 transition](project/licensing.md)
7878
- [Project history](project/history.md)
7979
- [Name and marks](project/trademarks.md)
80+
- [Brand guide for external use](project/brand-guide.md) ([中文：对外品牌使用指南](project/brand-guide.zh-CN.md))
81+
- [ADOPTERS](../ADOPTERS.md): voluntary self-attested adoption directory
8082

8183
## Documentation Policy
8284

‎docs/community/ecosystem-adoption.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ projects. This page is a factual, public-safe inventory of what we observe.
1010
> are refreshed by a weekly scan; see
1111
> [Maintenance](#maintenance) below.
1212
13+
For voluntary, self-attested project and user entries, see the repository's
14+
[`ADOPTERS.md`](../../ADOPTERS.md) directory. This observed inventory and that
15+
directory intentionally use different evidence boundaries.
16+
1317
## 1. Integrations
1418

1519
Projects that call LoopX CLI/contracts in real flows, or adopted LoopX as a

‎docs/community/ecosystem-adoption.zh-CN.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ LoopX 正在被其他开源项目采样、集成和再实现。本页是这份
88
> **边界**：收录是事实记录，不代表背书。仅收录公开 GitHub 证据；状态变化
99
> （合并、关闭、改名、停滞）由每周扫描刷新，见[维护方式](#维护方式)。
1010
11+
项目和用户自愿提交的自报条目见仓库根目录的
12+
[`ADOPTERS.md`](../../ADOPTERS.md)。观察清单与自报目录有意保持不同的证据边界。
13+
1114
## 1. 真实集成
1215

1316
在真实流程中调用 LoopX CLI/契约、或把 LoopX 作为 provider 接入的项目。

‎docs/project/adopters.zh-CN.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# LoopX 采用者登记机制
2+
3+
这是一个由项目和用户自愿维护、自己声明的公开目录。登记表示公开关系，不代表
4+
testimonial、认证、安全审查、支持承诺或 maintainer 背书。
5+
6+
维护者基于公开证据观察的[生态采用清单](../community/ecosystem-adoption.zh-CN.md)
7+
仍然是独立的证据表面。根目录的 [`ADOPTERS.md`](../../ADOPTERS.md) 用于项目和用户
8+
主动描述自己的使用，也允许登记计划中或实验中的试用。
9+
10+
## 当前目录
11+
12+
目前还没有公开自报条目。这是有意保持的空状态：只有项目或用户愿意被公开点名时，
13+
才添加自己。
14+
15+
## 登记方式
16+
17+
项目或用户可以通过一个小型 PR 添加、更新或删除自己的行。无需提供内部账号、内部
18+
部署、credential、客户信息、raw transcript 或无法由公开证据支撑的效果结论。
19+
20+
复制以下格式，只填写能够公开支持的内容：
21+
22+
```md
23+
| 项目或用户 | 公开链接 | Integration / Workflow / Learning / Derivative | active / experimental / planned / paused | 一句话说明公开使用方式和边界 | YYYY-MM-DD |
24+
```
25+
26+
登记时：
27+
28+
1. 使用公开项目、个人主页、issue、PR、release 或文档链接；
29+
2. 说明实际使用了什么，以及处于计划中还是已经运行；
30+
3. 除非有公开证据，不要把某项结果归因于 LoopX；
31+
4. 运行仓库的 public/private 边界和文档检查；
32+
5. 按 [`CONTRIBUTING.md`](../../CONTRIBUTING.md) 对 commit 做 DCO sign-off。
33+
34+
这是一个有界的 public-doc 变更。拥有 merge 权限的协作者在检查通过后可以自合并；
35+
没有该权限的项目或用户可以提交同样的小型 PR，走正常 maintainer 合并路径。添加条目
36+
不会授予仓库、产品、支持或背书权限。
37+
38+
条目所有者可以随时请求删除。对于失效链接、混淆关系、私有内容或缺乏支持的结论，
39+
maintainer 可以要求更新或移除，并保留公开变更历史。

‎docs/project/brand-guide.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# LoopX Brand Guide For External Use
2+
3+
This guide is for open-source projects, commercial companies, users, writers,
4+
and event organizers that want to mention LoopX, describe an integration, or
5+
show the LoopX name or artwork. It is practical project guidance, not legal
6+
advice. The separate [Name And Marks](trademarks.md) page records the current
7+
project position on names and marks.
8+
9+
The short rule is: identify LoopX accurately, identify your own product clearly,
10+
and never make a reader infer sponsorship, certification, partnership, or an
11+
official release where none exists.
12+
13+
## 1. What LoopX Is
14+
15+
Use this description as a factual starting point:
16+
17+
> LoopX is an open, provider-neutral, local-first dynamic goal control plane
18+
> for long-running agent work. It keeps goals, todos, decision scope, gates,
19+
> evidence, quota, handoff, and recovery legible across bounded turns.
20+
21+
LoopX runs on top of agent harnesses. The harness or application still executes
22+
the work; LoopX keeps the control state reviewable and recoverable.
23+
24+
Do not describe LoopX as a model, an agent runtime, a complete agent platform,
25+
or an autonomous production controller. LoopX does not grant credentials,
26+
approve destructive or production actions, or turn an unverified run into proof
27+
of success.
28+
29+
## 2. Choose The Relationship Words First
30+
31+
Choose the narrowest relationship that your public implementation and evidence
32+
support:
33+
34+
| If your project or product… | Say… | Do not imply… |
35+
| --- | --- | --- |
36+
| links to or discusses LoopX | “mentions LoopX” or “documents LoopX” | an integration or endorsement |
37+
| calls a public LoopX command or contract | “uses LoopX” | that LoopX operates your service |
38+
| exchanges state through a maintained adapter | “integrates with LoopX” | that the adapter is an official product |
39+
| adds a provider or extension around LoopX | “extends LoopX” | that the extension is maintained by LoopX |
40+
| is a modified distribution | “a fork of LoopX” or “based on LoopX” | that it is an official LoopX release |
41+
| is only exploring an idea | “proposed” or “experimental” | shipped compatibility |
42+
43+
Only use “official LoopX”, “certified by LoopX”, “LoopX partner”, or similar
44+
language when a maintainer has explicitly authorized that wording for the
45+
specific surface and version.
46+
47+
## 3. Name And Package Usage
48+
49+
- Write the project name as **LoopX**. Do not write `Loop X`, `loop-x`, or use
50+
an unqualified “autonomous agent platform” as a substitute.
51+
- A project, company, hosted service, package, domain, or social account that
52+
is not operated by LoopX should not use `LoopX` as its primary identity in a
53+
way that looks official.
54+
- Descriptive names such as `acme-loopx-adapter` may explain a real
55+
integration, but the surrounding page must identify Acme as the operator and
56+
must not use “official” or equivalent language.
57+
- A fork or materially modified distribution should have its own primary name;
58+
state the LoopX relationship in a secondary description instead.
59+
- Keep the exact project name and relationship visible in titles, package
60+
descriptions, directory listings, and social profile bios rather than hiding
61+
it in a badge or footer.
62+
63+
## 4. Logo And Artwork
64+
65+
The repository's current public artwork is available under [`docs/assets/`](../assets/),
66+
including [`loopx-logo.png`](../assets/loopx-logo.png), the social preview, and
67+
control-plane diagrams.
68+
69+
When showing a mark or screenshot:
70+
71+
- preserve the artwork, aspect ratio, and readable contrast;
72+
- keep enough surrounding space that the mark is not mistaken for your own
73+
product mark;
74+
- link the surrounding reference to the official LoopX repository or docs;
75+
- identify your product as the operator when the mark appears on an integration
76+
page, hosted service, or commercial product page.
77+
78+
Do not redraw, distort, recolor, crop into a new logo, animate, combine, or
79+
place the mark in a way that makes your offering look like an official LoopX
80+
surface. Do not use a LoopX mark as the favicon, app icon, or primary avatar of
81+
an unrelated product without maintainer permission.
82+
83+
If the supplied artwork does not fit your layout, use the word **LoopX** in
84+
plain text and link to the project rather than inventing a replacement mark.
85+
86+
## 5. Guidance For Common External Surfaces
87+
88+
### Open-source README or documentation
89+
90+
Good:
91+
92+
> Acme Relay integrates with LoopX to persist bounded goal state. Acme Relay
93+
> is an independent project; see the integration guide and the LoopX project.
94+
95+
Include the relevant version, adapter, or command when the claim is version
96+
specific. A “works with LoopX” badge must link to a page that explains what is
97+
actually exercised; a badge is not proof of certification.
98+
99+
### Commercial product or hosted service
100+
101+
Name the company and service as the primary product. Explain what the service
102+
does with LoopX and who operates it. “Acme Cloud integrates with LoopX” is
103+
clearer than “LoopX Cloud” when LoopX does not operate the service.
104+
105+
Do not use LoopX in a pricing tier, domain, account name, or sales headline in a
106+
way that suggests the service is hosted, sold, or supported by the LoopX
107+
project. Do not claim a partnership merely because an API or adapter exists.
108+
109+
### Fork, plugin, extension, or distribution
110+
111+
Give the distribution a distinct primary name and describe the relationship:
112+
“Acme Flow, a fork of LoopX” or “Acme Flow, an extension for LoopX.” Preserve
113+
the notices required by the applicable software license. Make material changes,
114+
support boundaries, and the absence of LoopX endorsement clear.
115+
116+
### Blog, talk, benchmark, or comparison
117+
118+
Use LoopX to identify the subject accurately. Attribute measurements to the
119+
specific public setup, version, and evidence. Do not turn a single demo, star
120+
count, benchmark row, or user report into a claim that LoopX universally
121+
delivers the result.
122+
123+
## 6. Co-branding, Campaigns, And Official-looking Uses
124+
125+
Ask maintainers before launch if a use involves any of the following:
126+
127+
- a joint logo, “official” integration badge, certification, or partner mark;
128+
- a hosted service, paid offering, conference track, or campaign whose name
129+
prominently includes LoopX;
130+
- a package, domain, social account, or app icon that could be confused with a
131+
LoopX-operated surface;
132+
- a press quote, launch copy, or compatibility statement presented as a LoopX
133+
announcement;
134+
- a modified distribution whose visual identity closely follows the LoopX
135+
project identity.
136+
137+
Open a focused GitHub issue with the proposed wording, surface, and relevant
138+
version. Do not put credentials, private evidence, embargoed security details,
139+
or private business arrangements in the issue.
140+
141+
## 7. ADOPTERS And Public Attribution
142+
143+
Projects and users may voluntarily add a public, self-attested entry to
144+
[`ADOPTERS.md`](../../ADOPTERS.md). The directory records what the submitter
145+
claims to use, not what LoopX certifies or endorses. Choose an adoption mode,
146+
state whether it is active or experimental, link to public evidence, and avoid
147+
private or unverifiable claims.
148+
149+
The maintainer-observed [ecosystem adoption inventory](../community/ecosystem-adoption.md)
150+
is a different record. Do not copy an observation into `ADOPTERS.md` without a
151+
voluntary owner or user submission.
152+
153+
## 8. Attribution And Claim Hygiene
154+
155+
For any external reference:
156+
157+
1. Link **LoopX** to the canonical repository or the relevant versioned docs.
158+
2. Name the external project's operator and support boundary.
159+
3. Say which command, adapter, release, or public behavior was used.
160+
4. Label the claim as shipped, observed, reported, or proposed when the
161+
distinction matters.
162+
5. Say what the evidence does not establish; in particular, do not imply
163+
endorsement or universal capability.
164+
165+
The Apache and historical MIT license files cover the code and documentation
166+
under their terms. They do not turn a third-party product into an official
167+
LoopX product or grant permission to misrepresent project identity.
168+
169+
## 9. Quick Review Checklist
170+
171+
Before publishing a page, package, launch, or visual that mentions LoopX:
172+
173+
- Is **LoopX** spelled and linked correctly?
174+
- Is the external operator or author unmistakable?
175+
- Is the relationship word supported by the implementation and evidence?
176+
- Is the version, adapter, or tested surface named where relevant?
177+
- Could a reader mistake the page, package, logo, or service for an official
178+
LoopX offering?
179+
- Does the copy avoid certification, sponsorship, partnership, or endorsement
180+
language unless explicitly authorized?
181+
- Are screenshots, user data, private paths, and raw runs public-safe?
182+
- If the use is ambiguous, has a focused maintainer question been opened before
183+
launch?

0 commit comments

Comments
 (0)