Skip to content

Commit

Permalink
docs: overal refine
Browse files Browse the repository at this point in the history
  • Loading branch information
cdn0x12 committed Nov 12, 2024
1 parent 363dc30 commit ee17053
Show file tree
Hide file tree
Showing 17 changed files with 182 additions and 40 deletions.
9 changes: 2 additions & 7 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export default defineConfig({
{ text: '搜素', link: '/faq/search' },
{ text: '过滤、静音与屏蔽', link: '/faq/filter' },
{ text: '功能支持', link: '/faq/feature' },
{ text: '兼容性', link: '/faq/compatibility' },
{ text: '隐私与安全', link: '/faq/privacy-and-security' }
]
},
Expand All @@ -105,17 +106,11 @@ export default defineConfig({
{ text: 'Owu Board', link: '/services/board' }
]
},
{
text: '开发',
collapsed: true,
items: [
{ text: 'API', link: 'https://scg-docs.owu.one/dev/api/' }
]
},
{
text: '其他',
collapsed: true,
items: [
{ text: '开发文档', link: '/dev' },
{ text: '相关实例', link: '/instances' },
{ text: '服务状态', link: '/status' },
{ text: '更新日志', link: '/changelog' },
Expand Down
19 changes: 19 additions & 0 deletions credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,29 @@ description: Owu Social 食用说明的参考内容。
- [Mastodon 官方文档](https://docs.joinmastodon.org/)
- [喵窝资料室](https://docs.nya.one/)
- [Misskey食用指南](https://eat-misskey.github.io/)
- [GoToSocial Federation Status](https://codeberg.org/SadmL/gotosocial-federation-status)

## 图标

我们使用了以下图标库或图标项目的图标,特此声明并表示感谢。

- GoToSocial 的官方图标
- [Noun Project](https://thenounproject.com/)

## 表情

Owu Social 使用了以下表情包,特此声明并表示感谢。如有侵权请[联系我们](/contact.md),我们将尽快处理。

| 表情包 | 作者 |
| --- | --- |
| Blob | [Google](https://emojicombos.com/) |
| Bun | [@volpeon@is-a.wyvern.rip](https://is-a.wyvern.rip/@volpeon) |
| Chiikawa | [Nangroo](https://x.com/ngnchiikawa) |
| Floof | [@volpeon@is-a.wyvern.rip](https://is-a.wyvern.rip/@volpeon) |
| FoxFriends | [magpie](https://x.com/magpie_egg) |
| JokeBear | [Nangroo](https://x.com/ngntrtr) |
| MellowCroquette | [Nangroo](https://x.com/ngntrtr) |
| Neocat | [@volpeon@is-a.wyvern.rip](https://is-a.wyvern.rip/@volpeon) |
| Symbols | 各平台标识作者 |
| TransFormersMTE | [Tomy](https://www.takaratomy.co.jp/), [Hasbro](https://corporate.hasbro.com/), 导入自 stelpolva.moe |
| 小豆泥 | [Nobeko](https://x.com/yamanobejin) |
30 changes: 30 additions & 0 deletions dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: 开发文档
description: Owu Social 的开发文档
---

# 开发文档

## 可用资源

::: details GoToSocial官方文档
Owu Social 维护了完整的 GoToSocial 官方中文文档,已合并到 GoToSocial 上游。若要进行客户端开发和服务接入,推荐阅读“客户端 API 文档”部分;若要开发与 GoToSocial 进行联合的 ActivityPub 服务端,推荐阅读“联合”部分。

[https://docs.gotosocial.org/zh-cn/latest/](https://docs.gotosocial.org/zh-cn/latest/)
:::

::: details API 文档
GoToSocial 通过 Swagger 提供 OpenAPI v2文档,可以通过以下链接查看:

[https://docs.gotosocial.org/zh-cn/latest/api/swagger/](https://docs.gotosocial.org/zh-cn/latest/api/swagger/)
:::

::: details 贡献指引
GoToSocial 的贡献指引可以[在此](https://github.com/superseriousbusiness/gotosocial/blob/main/docs/locales/zh/repo/CONTRIBUTING.md)查看。
:::

::: details GoToSocial 源代码
Owu Social 目前使用与 GoToSocial 上游一致的源代码。GoToSocial 的源代码托管在 GitHub 上,可以通过以下链接查看:

[https://github.com/superseriousbusiness/gotosocial](https://github.com/superseriousbusiness/gotosocial)
:::
12 changes: 0 additions & 12 deletions dev/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion faq/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ description: 如何登录Owu Social,以及推荐的客户端应用。
- [Phanpy](https://phanpy.owu.one) <Badge text="推荐" type="info" />
- [Elk](https://elk.owu.one)
- [Mastodon FE](https://masto-fe.owu.one) (Mastodon独立前端)
- [Enafore](https://enafore.owu.one)
- [Soapbox](https://soapbox.owu.one)

此外还有以下第三方网页客户端:
- [Semaphore](https://semaphore.social/)
- [Trunks](https://trunks.social/)


### Android

- [Moshidon](https://github.com/LucasGGamerM/moshidon/releases/latest) <Badge text="推荐" type="info" />
Expand Down
104 changes: 104 additions & 0 deletions faq/compatibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
title: 联合与兼容性
description: Owu Social 与其它 ActivityPub 实现和平台的联合情况
---

# 联合与兼容性

本页总结了 Owu Social 与其他 ActivityPub 实现和平台的联合与兼容情况。

::: details 符号说明
- ✅ - 没有问题
- ☑️ - 小问题(特定情况下有问题)
- ❓ - 未知/没有可联合的公开实例
- ⚠️ - 可发现账户,但无法关注(通常是因为对方实例未执行签名等必要安全措施)
- ❌ - 无法发现账户/不可联合
- 👻 - 软件已过时/停止更新一年或更长时间
- 📋 - 链接到与软件相关的 [fediverse.observer](https://fediverse.observer/list) 列表
:::

| 软件 | 联合情况 | 问题 | 测试的实例/账户(如果有) |
| --- | --- | --- | --- |
| [Mastodon](https://github.com/mastodon/mastodon) [📋](https://mastodon.fediverse.observer/list) || | |
| Mastodon 派生软件 |
| [Ecko](https://github.com/magicstone-dev/ecko) [📋](https://ecko.fediverse.observer/list) || | |
| [Fedibird](https://github.com/fedibird/mastodon) 👻 [📋](https://mastodon.fediverse.observer/list) || | |
| [Glitchcafe](https://github.com/pluralcafe/glitchcafe) 👻 [📋](https://glitchcafe.fediverse.observer/list) || | |
| [Glitch-soc](https://github.com/glitch-soc/mastodon) || | |
| [Hometown](https://github.com/hometown-fork/hometown) [📋](https://hometown.fediverse.observer/list) || | |
| |
| [Misskey](https://github.com/misskey-dev/misskey) [📋](https://hometown.fediverse.observer/list) | ☑️ | [Misskey #14915](https://github.com/misskey-dev/misskey/issues/14915) | https://misskey.io/@cdn |
| Misskey 派生软件 |
| [CherryPick](https://github.com/kokonect-link/cherrypick) [📋](https://cherrypick.fediverse.observer/list) | ☑️ | 同 Misskey | |
| [Firefish](https://firefish.dev/firefish/firefish) [📋](https://firefish.fediverse.observer/list) || | |
| [Foundkey](https://akkoma.dev/FoundKeyGang/FoundKey) [📋](https://foundkey.fediverse.observer/list) || | |
| [Iceshrimp](https://iceshrimp.dev/iceshrimp/iceshrimp) [📋](https://iceshrimp.fediverse.observer/list) + [Iceshrimp.NET](https://iceshrimp.dev/iceshrimp/iceshrimp.net) [📋](https://iceshrimpnet.fediverse.observer/list) || | |
| [Sharkey](https://activitypub.software/TransFem-org/Sharkey) [📋](https://sharkey.fediverse.observer/list) | ☑️ | 同 Misskey | |
| |
| [Betula](https://sr.ht/~bouncepaw/betula) [📋](https://betula.fediverse.observer/list) || | [@danila@links.danilax86.space](https://links.danilax86.space/@danila) |
| [Bluesky](https://bsky.social) || | Bluesky 使用 AT 协议而非 ActivityPub,无法与 Owu Social 联合。有开发者实现了从 Bluesky 到 ActivityPub 的内容镜像。只要实现正确,Owu Social 可以与这些镜像服务联合,镜像账户适用于[特殊账户](/rules/special-accounts.md)的额外规定。 |
| [Bonfire](https://github.com/bonfire-networks) | ⚠️ | | https://hiti.nairatmya.org/@mossbeard |
| [Bookwyrm](https://github.com/bookwyrm-social/bookwyrm) [📋](https://bookwyrm.fediverse.observer/list) || | [@jussi@books.duck.cafe](https://books.duck.cafe/user/jussi) |
| [Bovine](https://codeberg.org/bovine/bovine) | ⚠️ | | @moocow@bovine.fly.dev |
| [Brutalinks](https://git.sr.ht/~mariusor/brutalinks) | ⚠️ | | [@marius@brutalinks.tech](https://brutalinks.tech/~marius) |
| [Bugle](https://github.com/rknightuk/bugle) [📋](https://bugle.fediverse.observer/list) || | [@zobot@bugle.lol](https://bugle.lol/@zobot) |
| [Castopod](https://code.castopod.org/adaures/castopod) | ⚠️ | [Castopod #364](https://code.castopod.org/adaures/castopod/-/issues/364) | https://p.skobk.in/@sporadic_podcast |
| [Dokieli](https://github.com/linkeddata/dokieli) || ||
| [Emissary](https://github.com/EmissarySocial/emissary) [📋](https://emissary.fediverse.observer/list) | ⚠️ | | https://benpate.dev/@ben |
| [Epicyon](https://gitlab.com/bashrc2/epicyon) || ||
| [Forgejo](https://codeberg.org/forgejo/forgejo) [📋](https://forgejo.fediverse.observer/list) | ⚠️ | | [@K0RR@git.sakamoto.pl](https://git.sakamoto.pl/K0RR) |
| [Funkwhale](https://dev.funkwhale.audio/funkwhale/funkwhale) [📋](https://funkwhale.fediverse.observer/list) || | https://audio.pepemoss.com/@earl |
| [Friendica](https://github.com/friendica/friendica) [📋](https://friendica.fediverse.observer/list) | ☑️ | [Friendica #14316](https://github.com/friendica/friendica/issues/14316) | https://entropysource.ru/profile/hubbitant |
| [Ganico](https://github.com/lesion/gancio) [📋](https://gancio.fediverse.observer/list) || | |
| [GNU Social](https://notabug.org/diogo/gnu-social) 👻 [📋](https://gnusocial.fediverse.observer/list) || | |
| [Goblin](https://github.com/johnHackworth/goblin) [📋](https://goblin.fediverse.observer/list) || | https://goblin.band/@goblin |
| [Gotosocial](https://github.com/superseriousbusiness/gotosocial) [📋](https://gotosocial.fediverse.observer/list) || | https://gts.superseriousbusiness.org/@gotosocial |
| [Hamabē](https://codeberg.org/hamabe/hamabe) [📋](https://hamabe.fediverse.observer/list) || | [@mochi@try.hamabe.space](https://try.hamabe.space/public/@mochi) |
| [Hollo](https://github.com/dahlia/hollo) [📋](https://hollo.fediverse.observer/list) || | https://hollo.social/@hollo |
| [Honk](https://humungus.tedunangst.com/r/honk) [📋](https://honk.fediverse.observer/list) || | https://h.icyphox.sh/@icy |
| [Hubzilla](https://framagit.org/hubzilla) [📋](https://hubzilla.fediverse.observer/list) || | |
| [Juick](https://x.juick.com/Juick) || [GtS #3268](https://github.com/superseriousbusiness/gotosocial/issues/3268), [GtS #1820](https://github.com/superseriousbusiness/gotosocial/issues/1820) | [@Linda-chan@juick.com](https://juick.com/Linda-chan) |
| [Kepi](https://gitlab.com/marnanel/chapeau) 👻 [📋](https://kepi.fediverse.observer/list) || ||
| [Kitsune](https://github.com/kitsune-soc/kitsune) || ||
| [Ktistec](https://github.com/toddsundsted/ktistec) [📋](https://ktistec.fediverse.observer/list) | ⚠️ | [Ktistec #103](https://github.com/toddsundsted/ktistec/issues/103), [GtS #2991](https://github.com/superseriousbusiness/gotosocial/issues/2991) | https://epiktistes.com/@toddsundsted |
| [Kroeg](https://puck.moe/git/kroeg) 👻 [📋](https://kroeg.fediverse.observer/list) | ⚠️ | | https://puckipedia.com/ |
| [Lemmy](https://github.com/LemmyNet/lemmy) [📋](https://lemmy.fediverse.observer/list) | ☑️ | [GtS #2697](https://github.com/superseriousbusiness/gotosocial/issues/2697), [All issues related to GtS](https://github.com/LemmyNet/lemmy/issues?q=is%3Aissue+gotosocial) | [user](https://lemmygrad.ml/u/yogthos), [community](https://lemmygrad.ml/c/funny)<br/>注:[Owu Board](https://bdl.owu.one) 和其它所有手动启用了Activity签名的 Lemmy 实例已经能与 Owu Social 正常联合 |
| [Letterbook](https://github.com/Letterbook/Letterbook) || ||
| [Magnetar](https://git.astolfo.cool/natty/magnetar) || ||
| [Mbin](https://github.com/MbinOrg/mbin) ([Kbin](https://github.com/ernestwisniewski/kbin) 的维护状态存疑) [📋](https://mbin.fediverse.observer/list) | ⚠️ | 可以关注用户,但不能关注栏目(Magzine) | [user](https://kbin.earth/u/jwr1), [magazine](https://kbin.earth/m/kbinEarth) |
| [microblog.pub](https://git.sr.ht/~tsileo/microblog.pub) 👻 [📋](https://microblogpub.fediverse.observer/list) || | [@josh@heretic.li](https://heretic.li) |
| [micro.blog](https://micro.blog) [📋](https://microdotblog.fediverse.observer/list) | ⚠️ | | [@manton@manton.org](https://manton.org) |
| [Mitra](https://codeberg.org/silverpill/mitra) [📋](https://mitra.fediverse.observer/list) || | https://mochi.mochikov.ski/@mochi |
| [Mobilizon](https://framagit.org/framasoft/mobilizon) [📋](https://mobilizon.fediverse.observer/list) || | |
| [NeoDB](https://github.com/neodb-social/neodb) [📋](https://neodb.fediverse.observer/list) | ⚠️ | 可以正常登录使用,但无法关注纯NeoDB账号 | [@Zucchini@minreol.dk](https://minreol.dk/users/Zucchini) |
| [NodeBB](https://github.com/NodeBB/NodeBB) [📋](https://nodebb.fediverse.observer/list) | ⚠️ | | https://ekk.app/user/bh4-tech |
| [OCamlot](https://github.com/kiranandcode/ocamlot) 👻 [📋](https://ocamlot.fediverse.observer/list) || | https://ocamlot.xyz/users/gopiandcode |
| [PeerTube](https://github.com/Chocobozzz/PeerTube) [📋](https://peertube.fediverse.observer/list) | ⚠️ | [PeerTube #6462](https://github.com/Chocobozzz/PeerTube/issues/6462) | [@it@peervideo.ru](https://peervideo.ru/c/it) |
| [Piefed](https://codeberg.org/rimu/pyfedi) [📋](https://piefed.fediverse.observer/list) | ⚠️ | 可以关注用户,但无法关注社区 | [user](https://piefed.social/u/Jerry), [community](https://piefed.social/c/piefed_meta) |
| [Pixelfed](https://github.com/pixelfed/pixelfed) [📋](https://pixelfed.fediverse.observer/list) || | |
| |
| [Pleroma](https://git.pleroma.social/pleroma) [📋](https://pleroma.fediverse.observer/list) || | |
| Pleroma 派生软件 |
| [Akkoma](https://akkoma.dev/AkkomaGang/akkoma) [📋](https://akkoma.fediverse.observer/list) || | |
| [Rebased](https://gitlab.com/soapbox-pub/rebased) || ||
| |
| [Plume](https://github.com/Plume-org/Plume) [📋](https://plume.fediverse.observer/list) | ⚠️ | | [@paradoxal@zone.paradoxal.netlib.re](https://zone.paradoxal.netlib.re/@/paradoxal) |
| [upub](https://moonlit.technology/alemi/upub) || | https://dev.upub.social/web/actors/alemi |
| [Seppo](https://codeberg.org/seppo/seppo) || [GtS #2961](https://github.com/superseriousbusiness/gotosocial/issues/2961#issue-2333014325), [GtS #1186](https://github.com/superseriousbusiness/gotosocial/issues/1186) | https://seppo.social/aseppototry/o/p/ |
| [Socialhome](https://github.com/jaywink/socialhome) [📋](https://socialhome.fediverse.observer/list) || | [@delcake@delcake.com](https://delcake.com) |
| [Shuttlecraft](https://github.com/benbrown/shuttlecraft) 👻 [📋](https://shuttlecraft.fediverse.observer/list) || | https://cerritos.glitch.me |
| [Smithereen](https://github.com/grishka/Smithereen) [📋](https://smithereen.fediverse.observer/list) || | |
| [snac](https://codeberg.org/grunfink/snac2) [📋](https://snac.fediverse.observer/list) || | https://blog.sn4il.site/sn4il |
| [Streams](https://codeberg.org/streams/streams) || | https://fediversity.site/channel/streams |
| [Swanye](https://codeberg.org/WammKD/Swanye) || | |
| [Takahē](https://github.com/jointakahe/takahe) [📋](https://takahe.fediverse.observer/list) | ⚠️ | [Takahe #223](https://github.com/jointakahe/takahe/issues/223), [Takahe #528](https://github.com/jointakahe/takahe/issues/528) | [@wezza83@coot.vabl.dev](https://coot.vabl.dev/@wezza83@coot.vabl.dev) |
| [Tapir](https://github.com/ar-nelson/tapir) 👻 || ||
| [Threads](https://threads.net) || [GtS #2491](https://github.com/superseriousbusiness/gotosocial/issues/2491) | Threads 并不开源,实行不透明的联合规则,且未按规范返回 ActivityPub 数据,GoToSocial 无意针对 Threads 进行特殊处理。我们赞同这种做法。 |
| [Toki](https://github.com/purifetchi/Toki) || ||
| [Twitter/X](https://x.com) || | Twitter 不使用 ActivityPub,但有开发者实现了从 Twitter 到 ActivityPub 的单项内容镜像。只要实现正确,Owu Social 可以与这些镜像服务联合,镜像账户适用于[特殊账户](/rules/special-accounts.md)的额外规定。 |
| [Wafrn](https://github.com/gabboman/wafrn) [📋](https://wafrn.fediverse.observer/list) || | https://app.wafrn.net/dashboard/exploreLocal |
| [Writefreely](https://github.com/writefreely/writefreely) [📋](https://writefreely.fediverse.observer/list) | ☑️ | | [@baslow@read.asorrybowl.blog](https://read.asorrybowl.blog)<br/>注:[Owu Write](https://write.owu.one) 和其它所有更新到v0.15.1及之后版本的 Writefreely 实例可与 Owu Social 正常联合 |
| [write.as](https://write.as) (付费版? Writefreely) | ⚠️ | | [@write-as-roscoes-story@write.as](https://write.as/write-as-roscoes-story) |
| [Wordpress](https://github.com/WordPress/wordpress-develop) [📋](https://wordpress.fediverse.observer/list) | ⚠️ / ✅ | 取决于使用的 [ActivityPub](https://en.wikipedia.org/wiki/ActivityPub) 插件 | |
| [wxwClub](https://github.com/wxwmoe/wxwClub) || | https://ovo.st/club/board |
| [Yarn](https://git.mills.io/yarnsocial/yarn) || ||
4 changes: 2 additions & 2 deletions faq/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ description: Owu Social 的功能支持情况

| 功能 | 支持计划 |
| --- | --- |
| 在主页显示转发 | 即将发布(已有 [PR #3346](https://github.com/superseriousbusiness/gotosocial/pull/3346),预计在 v0.18 发布) |
| 编辑贴文 | 预计 2024 年底到 2025 年初发布, 具体参见 [Issue #1990](https://github.com/superseriousbusiness/gotosocial/issues/1990) |
| 在主页显示转发 | 即将发布(已有 [PR #3346](https://github.com/superseriousbusiness/gotosocial/pull/3346)) |
| 编辑贴文 | 预计在 v0.18 发布, 具体参见 [Issue #1990](https://github.com/superseriousbusiness/gotosocial/issues/1990) |
| 客户端授权管理 | 预计 2024 年底到 2025 年初发布, 具体参见 [Issue #1081](https://github.com/superseriousbusiness/gotosocial/issues/1081), [Issue #1573](https://github.com/superseriousbusiness/gotosocial/issues/1573), [Issue #2227](https://github.com/superseriousbusiness/gotosocial/issues/2227), [Issue #2523](https://github.com/superseriousbusiness/gotosocial/issues/2523) |
| 中继 | 预计 2024 年底到 2025 年初发布, Owu Social 通过单向订阅中继保证你能接触到广泛的内容,但你公开发布的内容目前只能依靠他人的主动关注和转发来进入其它实例。具体参见 [Issue #1123](https://github.com/superseriousbusiness/gotosocial/issues/1123), [Issue #1124](https://github.com/superseriousbusiness/gotosocial/issues/1124) |
| 双因素认证 | 预计 2024 年底到 2025 年初发布 |
Expand Down
2 changes: 1 addition & 1 deletion faq/fediverse.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ QQ空间、微博、小红书、推特(X)、Instagram……这样的社交平台
在联邦宇宙中,你的用户名格式是 `@用户名@实例地址` —— 这和邮箱地址的格式很像,只不过前面多了一个`@`

::: details Mastodon的一些特殊称呼
Mastodon被很多中文用户称作“长毛象”。与推特的命名规则类似,推特的“推文”(帖子)在这里被称为“嘟文”(嘟嘟是小象的叫声),发帖(推特上的“发推”)在这里被称作“发嘟”。锁定自己的账号(在推特上被称为“锁推”)在这里被称作“锁嘟”;Mastodon实例的用户之间互称“嘟友”或“象友”。
Mastodon被很多中文用户称作“长毛象”。与推特的命名规则类似,推特的“推文”(帖子)在这里被称为“嘟文”(嘟嘟是小象的叫声),发帖(推特上的“发推”)在这里被称作“发嘟”。锁定自己的账号(在推特上被称为“锁推”)在这里被称作“锁嘟”;Mastodon实例的用户之间互称“嘟友”或“象友”(谐音“香油”)
:::

## 为什么选择联邦宇宙
Expand Down
Loading

0 comments on commit ee17053

Please sign in to comment.