Skip to content

Commit 1d6f2d1

Browse files
author
DevBot
committed
docs(repo): fold SUPPORT.md into CONTRIBUTING.md and BRAND.md into READMEs
1 parent 93edfad commit 1d6f2d1

6 files changed

Lines changed: 21 additions & 22 deletions

File tree

BRAND.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,10 @@ For release work, also run the release gates listed in
8484
Release work must follow `docs/governance/PROJECT_WORKFLOW.md`. Do not bump
8585
packages until implementation gates pass. Do not merge `dev` to `main` until
8686
`dev` CI is green. Do not tag until `main` CI is green.
87+
88+
## Support
89+
90+
Use [GitHub Discussions](https://github.com/open-element/openelement/discussions)
91+
for usage questions, design discussion, and help choosing an API. Use an issue
92+
only for a reproducible bug, a concrete documentation defect, or an agreed
93+
feature proposal.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,14 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md). Architecture decisions live in
9595
[docs/adr/](./docs/adr/); historical release and audit records remain available
9696
as evidence, not current product documentation.
9797

98+
## Brand
99+
100+
The canonical compact mark is the dark `<open/>` SVG in
101+
[`www/public/favicon.svg`](./www/public/favicon.svg)
102+
(`open-favicon-inverted.svg` is the maintained light-surface variant). Brand
103+
SVGs are distributed under the repository MIT license; forks may reuse them
104+
with attribution but should not imply endorsement.
105+
98106
## License
99107

100108
MIT

README.zh.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ deno task dev
8080
参见 [CONTRIBUTING.md](./CONTRIBUTING.md)。架构决策在 [docs/adr/](./docs/adr/)
8181
历史 release 与 audit 记录保留为证据,不再作为当前产品文档。
8282

83+
## 品牌
84+
85+
规范的紧凑标志是 [`www/public/favicon.svg`](./www/public/favicon.svg) 中的深色
86+
`<open/>` SVG(`open-favicon-inverted.svg` 是浅色背景的维护变体)。品牌 SVG
87+
以仓库 MIT 许可证分发;fork 可以署名使用,但不应暗示获得上游背书。
88+
8389
## 许可
8490

8591
MIT

SUPPORT.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

tools/check-public-docs-integrity.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ const failures: Failure[] = [];
6565
const requiredCommunityFiles = [
6666
'SECURITY.md',
6767
'CODE_OF_CONDUCT.md',
68-
'SUPPORT.md',
6968
'MAINTAINERS.md',
7069
];
7170

0 commit comments

Comments
 (0)