📝 Solar Network basis
This commit is contained in:
parent
b09eef4d23
commit
225b1ed8f6
@ -1,28 +1,32 @@
|
||||
// @ts-check
|
||||
import { defineConfig } from 'astro/config';
|
||||
import starlight from '@astrojs/starlight';
|
||||
import { defineConfig } from "astro/config";
|
||||
import starlight from "@astrojs/starlight";
|
||||
|
||||
// https://astro.build/config
|
||||
export default defineConfig({
|
||||
integrations: [
|
||||
starlight({
|
||||
title: 'My Docs',
|
||||
social: {
|
||||
github: 'https://github.com/withastro/starlight',
|
||||
},
|
||||
sidebar: [
|
||||
{
|
||||
label: 'Guides',
|
||||
items: [
|
||||
// Each item here is one entry in the navigation menu.
|
||||
{ label: 'Example Guide', slug: 'guides/example' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Reference',
|
||||
autogenerate: { directory: 'reference' },
|
||||
},
|
||||
],
|
||||
}),
|
||||
],
|
||||
integrations: [
|
||||
starlight({
|
||||
title: "Goatpedia",
|
||||
defaultLocale: "root",
|
||||
locales: {
|
||||
root: {
|
||||
label: "English",
|
||||
lang: "en",
|
||||
},
|
||||
"zh-cn": {
|
||||
label: "简体中文",
|
||||
lang: "zh-CN",
|
||||
},
|
||||
},
|
||||
social: {
|
||||
github: "https://github.com/Solsynth",
|
||||
},
|
||||
sidebar: [
|
||||
{
|
||||
label: 'Solar Network',
|
||||
autogenerate: { directory: 'solar-network' },
|
||||
},
|
||||
],
|
||||
}),
|
||||
],
|
||||
});
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 96 KiB |
@ -1,11 +0,0 @@
|
||||
---
|
||||
title: Example Guide
|
||||
description: A guide in my new Starlight docs site.
|
||||
---
|
||||
|
||||
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
|
||||
Writing a good guide requires thinking about what your users are trying to do.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
|
||||
@ -1,36 +1,21 @@
|
||||
---
|
||||
title: Welcome to Starlight
|
||||
description: Get started building your docs site with Starlight.
|
||||
title: Welcome to Goatpedia
|
||||
description: The official knowledge base for Solsynth Products.
|
||||
template: splash
|
||||
hero:
|
||||
tagline: Congrats on setting up a new Starlight project!
|
||||
tagline: All you want to know about Solsynth Products, all in one place.
|
||||
image:
|
||||
file: ../../assets/houston.webp
|
||||
file: https://solsynth.dev/favicon.png
|
||||
actions:
|
||||
- text: Example Guide
|
||||
link: /guides/example/
|
||||
- text: Getting Started
|
||||
link: /solar-network
|
||||
icon: right-arrow
|
||||
- text: Read the Starlight docs
|
||||
link: https://starlight.astro.build
|
||||
icon: external
|
||||
variant: minimal
|
||||
---
|
||||
|
||||
import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||
import { LinkCard } from '@astrojs/starlight/components';
|
||||
|
||||
## Next steps
|
||||
## Under construction
|
||||
|
||||
<CardGrid stagger>
|
||||
<Card title="Update content" icon="pencil">
|
||||
Edit `src/content/docs/index.mdx` to see this page change.
|
||||
</Card>
|
||||
<Card title="Add new content" icon="add-document">
|
||||
Add Markdown or MDX files to `src/content/docs` to create new pages.
|
||||
</Card>
|
||||
<Card title="Configure your site" icon="setting">
|
||||
Edit your `sidebar` and other config in `astro.config.mjs`.
|
||||
</Card>
|
||||
<Card title="Read the docs" icon="open-book">
|
||||
Learn more in [the Starlight Docs](https://starlight.astro.build/).
|
||||
</Card>
|
||||
</CardGrid>
|
||||
We're currently working the Simplfied Chinese version documentation, the English version will be released soon.
|
||||
|
||||
<LinkCard title="Visit Simplfied Chinese Version" description="查看 100% 翻译的简体中文版本文档" href="/zh-cn/" />
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
---
|
||||
title: Example Reference
|
||||
description: A reference page in my new Starlight docs site.
|
||||
---
|
||||
|
||||
Reference pages are ideal for outlining how things work in terse and clear terms.
|
||||
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
|
||||
|
||||
## Further reading
|
||||
|
||||
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
||||
8
src/content/docs/solar-network/index.mdx
Normal file
8
src/content/docs/solar-network/index.mdx
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Quick Start
|
||||
description: The Solar Network user manual.
|
||||
---
|
||||
|
||||
Welcome to the Solar Network user manual. This manual is intended to help you get started with the Solar Network.
|
||||
|
||||
Check out the Simplfied Chinese version for now. The English version is still under construction.
|
||||
13
src/content/docs/zh-cn/index.mdx
Normal file
13
src/content/docs/zh-cn/index.mdx
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
title: 欢迎来到山羊维基
|
||||
description: 关于索尔幸茨的产品的官方知识库。
|
||||
template: splash
|
||||
hero:
|
||||
tagline: Congrats on setting up a new Starlight project!
|
||||
image:
|
||||
file: https://solsynth.dev/favicon.png
|
||||
actions:
|
||||
- text: 开始探索
|
||||
link: /solar-network
|
||||
icon: right-arrow
|
||||
---
|
||||
48
src/content/docs/zh-cn/solar-network/account.mdx
Normal file
48
src/content/docs/zh-cn/solar-network/account.mdx
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Solarpass 账户
|
||||
description: 注册 Solarpass，迈出探索 Solar Network 的第一步吧。
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
我们称 Solar Network 上的帐户为 Solarpass。为了探索完整的 Solar Network 功能，你需要一个 Solarpass 账户。
|
||||
|
||||
:::caution[你知道吗？]
|
||||
根据我们的用户协议，一个自然人应该只能注册、拥有一个 Solarpass 账号。此外，转让、售卖、租用 Solarpass 的行为都是不允许的。
|
||||
如果违反以上的情况，我们有权终止你的 Solarpass 账户。
|
||||
:::
|
||||
|
||||
## 注册
|
||||
|
||||
你需要通过 Solian 来注册 Solarpass，你可以使用你的已经安装的本地客户端，或者我们的 [网页版本](https://sn.solsynth.dev/auth/register)
|
||||
|
||||
在你填写表单的时候，这些信息可能会帮助到你：
|
||||
|
||||
- 用户名：每个账号的唯一标识，注册之后无法改动，可以用于登录和他人可以通过 `@<username>` 的方式来提及你。最短为 4 个字符，只允许英文和阿拉伯数字出现。
|
||||
- 显示名：显示的名称，允许任何字符，最短为 4 个字符或者 2 个汉字、韩文、片假名或平假名。
|
||||
- 邮箱：账号的联系方式，确保此字段是真实的电子邮箱，我们会验证你的电子邮箱。
|
||||
- 密码：账号密码其中之一的验证因素，确保此字段安全，至少 4 个字符。
|
||||
|
||||
### 疑难杂症
|
||||
|
||||
- **(400) Key: 'XXX' Error: Field validation failed on the 'XXX' tag** 有一个或多个字段在服务器校验的时候发生了失败，请根据以上的信息检查你的表单。
|
||||
- **(400) ERROR: duplicate key value violates unique constraint "idx_accounts_name" (SQLSTATE 23505)** 你的用户名与现有的用户重复了，请考虑更换一个用户名
|
||||
|
||||
## 登陆
|
||||
|
||||
你可以使用你的电子邮件、用户名来登陆你的帐号。
|
||||
|
||||
Solar Network 使用独特的 **多因子验证** 来保护你的帐号安全。你在登陆界面的时候可以看到服务器均衡各方面因素得出的需求验证步数，
|
||||
你需要通过对应数量的验证因子才能登陆你的帐号，在一个登陆会话中不能重复使用一个相同的因子。
|
||||
|
||||
### 疑难杂症
|
||||
|
||||
- **(400) account was not found: XXX** 没有找到目标账户，检查你的用户名和电子邮件时候填写正确，我们不接受显示名来查找帐号
|
||||
- **(403) account was not confirmed; check your inbox, there will be an email lead you confirm your registration** 你的帐号还没激活，检查你的电子邮件收件箱，或者是垃圾邮件，会有一份标注 **[Solarpass]** 的电子邮件，里面包含一个连接来帮助激活你的账号
|
||||
- **(403) account was suspended** 你的帐号因为某些原因被我们停用了，你可以检查你绑定的邮件，一般情况下我们的客户服务会发送一份邮件来详细解释这项决定的依据和原因。
|
||||
|
||||
## 删除帐号
|
||||
|
||||
如果你想要删除你的帐号，你可以在你的账号中心中点击删除按钮，并在弹出的确认对话框中确认你的帐号删除。
|
||||
|
||||
之后，你绑定的电子邮箱会收到一封电子邮件。你可以根据邮件里的提示来完成你的删除操作。
|
||||
36
src/content/docs/zh-cn/solar-network/index.mdx
Normal file
36
src/content/docs/zh-cn/solar-network/index.mdx
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: 快速入门
|
||||
description: Solar Network 用户手册。
|
||||
sidebar:
|
||||
order: 0
|
||||
---
|
||||
|
||||
import { LinkCard } from '@astrojs/starlight/components';
|
||||
|
||||
欢迎来到 Solar Network 用户手册。这份手册旨在帮助您开始使用 Solar Network。
|
||||
|
||||
## 基础知识
|
||||
|
||||
Solar Network 是整个 HyperNet 项目的别称，它分为 HyperNet 服务器和用户经常使用的 Surface 应用（在市场上又名 Solian）。
|
||||
|
||||
你可以将 Solar Network 简写为 SN，大小写均可。但是在提及到它的应用程式时，请确保首字母大写。
|
||||
|
||||
- Solian ✅
|
||||
- Solar Network ✅
|
||||
- SN ✅
|
||||
- sn ✅
|
||||
- solian ❌
|
||||
- SOLIAN ❌
|
||||
|
||||
~~虽然你乱用 SN 的名字我也不能把你怎样，但是你用对名字总能让小羊看的舒服一点~~
|
||||
|
||||
## 开始使用
|
||||
|
||||
对于终端用户（End-user），开始使用 Solar Network 有几种方式：
|
||||
|
||||
- [安装 Solian 客户端](./installation) **最推荐**
|
||||
- [在网页版打开 Solian](https://sn.solsynth.dev)
|
||||
|
||||
为了探索完整的 Solar Network 功能，你需要一个 Solarpass 账户。
|
||||
|
||||
<LinkCard href="./account" title="Solarpass 账户" description="了解如何创建，管理你的 Solarpass 账户" />
|
||||
97
src/content/docs/zh-cn/solar-network/installation.mdx
Normal file
97
src/content/docs/zh-cn/solar-network/installation.mdx
Normal file
@ -0,0 +1,97 @@
|
||||
---
|
||||
title: 安装客户端
|
||||
description: 安装 Solian 客户端来使用 Solar Network。
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
import { LinkCard } from '@astrojs/starlight/components';
|
||||
|
||||
关于安装客户端，有两种方式，其一是使用我们预编译的二进制分发档案，其二是从源代码构建。
|
||||
|
||||
## 预编译
|
||||
|
||||
你可以通过我们的官方网站（英文）来下载到最新版本的预编译包裹。
|
||||
我们提供 Android, iOS, macOS, Windows 的预编译版本。
|
||||
|
||||
*Linux 也在支持列表之中，但是还请自行构建*
|
||||
|
||||
<LinkCard title="下载预编译安装包" description="前往 Capital 首都官方网站" target="_blank" href="https://solsynth.dev/products/solar-network#download" />
|
||||
|
||||
:::note
|
||||
关于 Windows 版本，我们使用 GitHub Actions 对每一个提交进行及时构建，官网存在的版本可能不是最新。
|
||||
可以前往我们的 [GitHub Repo](http://github.com/Solsynth/HyperNet.Surface) 下载最新 Windows 构建版本。
|
||||
:::
|
||||
|
||||
:::tip[你知道吗？]
|
||||
你其实也可以在 Matrix Marketplace 下载到 Solian 桌面版本，虽然可能不是最新版。
|
||||
:::
|
||||
|
||||
下载完成的档案直接安装即可。Windows 版本解压即可使用。
|
||||
|
||||
## 自行构建
|
||||
|
||||
要自行构建 Solian，你需要安装 Flutter 开发环境（Windows 需要额外安装 VS2019 以上版本，勾选 Desktop Development with C++）。
|
||||
|
||||
- 安装 Flutter 开发环境：[Flutter 官网](https://flutter.dev/docs/get-started/install)
|
||||
|
||||
:::note
|
||||
如果你处于中华人民共和国中，可能使用 Flutter 和其基础设施（pub.dev）时网络连接不会那么顺畅。
|
||||
请参考 Flutter 官方文档进行换源工作。
|
||||
:::
|
||||
|
||||
额外，你还需要安装 [Git](https://git-scm.com/downloads) 来克隆我们的源代码。
|
||||
|
||||
你可以执行以下的命令来检查所有的依赖项：
|
||||
|
||||
```bash
|
||||
git --version
|
||||
flutter doctor
|
||||
```
|
||||
|
||||
它应该会输出如下的信息：
|
||||
|
||||
```
|
||||
# git --version
|
||||
git version 2.47.1
|
||||
|
||||
# flutter doctor
|
||||
Doctor summary (to see all details, run flutter doctor -v):
|
||||
[✓] Flutter (Channel stable, 3.27.1, on macOS 15.1.1 24B91
|
||||
darwin-arm64, locale en-CN)
|
||||
[✓] Android toolchain - develop for Android devices (Android SDK
|
||||
version 34.0.0)
|
||||
[✓] Xcode - develop for iOS and macOS (Xcode 16.2)
|
||||
[✓] Chrome - develop for the web
|
||||
[✓] Android Studio (version 2024.2)
|
||||
[✓] IntelliJ IDEA Ultimate Edition (version 2024.3.2)
|
||||
[✓] Connected device (5 available)
|
||||
[✓] Network resources
|
||||
|
||||
• No issues found!
|
||||
```
|
||||
|
||||
接下来，我们就可以正式构建了
|
||||
|
||||
```bash
|
||||
# iOS
|
||||
flutter build ipa
|
||||
# macOS
|
||||
flutter build macos
|
||||
# Android (apk)
|
||||
flutter build apk --split-abi --release
|
||||
# Android (aab)
|
||||
flutter build appbundle
|
||||
# Windows
|
||||
flutter build windows
|
||||
# Linux
|
||||
flutter build linux
|
||||
# Web
|
||||
flutter build web --base-href=/ --release
|
||||
```
|
||||
|
||||
:::note
|
||||
因为使用的依赖关系，本项目展示不支持 Web WASM 的构建。
|
||||
:::
|
||||
|
||||
编译过程中会自动下载相关依赖，请稍等即可。构建完成后会输出构建结果的目录。
|
||||
Loading…
x
Reference in New Issue
Block a user