diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8863ee4..8ba095a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,23 +6,22 @@ Thank you for your interest in contributing to our documentation! This guide wil ## How to contribute -### Option 1: Edit directly on GitHub +### Edit directly on GitLab -1. Navigate to the page you want to edit -2. Click the "Edit this file" button (the pencil icon) -3. Make your changes and submit a pull request +1. Open the file you want to edit in the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals). If you don't have write access, fork the repository and open the file in your fork. +2. Select **Edit** > **Edit single file** and make your changes. +3. Commit your changes to a new branch and open a merge request targeting the manuals repository. -### Option 2: Local development +### Develop locally -1. Fork and clone this repository -2. Install the Mintlify CLI: `npm i -g mint` -3. Create a branch for your changes -4. Make changes -5. Navigate to the docs directory and run `mint dev` -6. Preview your changes at `http://localhost:3000` -7. Commit your changes and submit a pull request +1. Fork and clone the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals). +2. Run `npm i -g mint` to install the Mintlify CLI. +3. Create a branch and edit the documentation. +4. Run `mint dev` from the directory containing `docs.json`. +5. Preview your changes at `http://localhost:3000`. +6. Commit and push your branch, then open a merge request targeting the manuals repository. -For more details on local development, see our [development guide](development.mdx). +For more details, see the [local development instructions](README.md#开发). ## Writing guidelines diff --git a/README.md b/README.md index 29d2840..2d0470c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ AutoLibrary 北京建筑大学图书馆自动化工具的 Mintlify 文档站点。 +- [AutoLibrary 主项目（Gitea）](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary) +- [用户手册仓库（GitLab）](https://gitlab.com/KenanZhu/AutoLibraryManuals) +- [文档贡献指南](CONTRIBUTING.md) + ## 图片资源清单 ### v1.3.0 @@ -60,4 +64,4 @@ mint dev ## 发布 -更改推送到默认分支后将自动部署到生产环境。 +更改推送到 GitLab 仓库的默认分支后将自动部署到生产环境。 diff --git a/docs.json b/docs.json index 432f4bd..552536b 100644 --- a/docs.json +++ b/docs.json @@ -169,9 +169,9 @@ }, "links": [ { - "label": "GitHub", - "href": "https://github.com/KenanZhu/AutoLibrary", - "icon": "github" + "label": "项目源码", + "href": "https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary", + "icon": "code" } ] }, @@ -184,8 +184,20 @@ ] }, "footer": { - "socials": { - "github": "https://github.com/KenanZhu/AutoLibrary" - } + "links": [ + { + "header": "代码仓库", + "items": [ + { + "label": "AutoLibrary（Gitea）", + "href": "https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary" + }, + { + "label": "用户手册（GitLab）", + "href": "https://gitlab.com/KenanZhu/AutoLibraryManuals" + } + ] + } + ] } } diff --git a/zh/manual/v1.3.0/faq/contact.mdx b/zh/manual/v1.3.0/faq/contact.mdx index ae29a69..4fc8d30 100644 --- a/zh/manual/v1.3.0/faq/contact.mdx +++ b/zh/manual/v1.3.0/faq/contact.mdx @@ -5,23 +5,22 @@ description: "AutoLibrary 的相关链接，以及快速获取联系我们的方 ## 相关链接 -下列是快速获取与 AutoLibrary 相关的最新信息的方式，你可以跟踪最新的开发进展 -以及未来的开发规划 +你可以在这里查看 AutoLibrary 源码、下载软件和参与手册维护。 - 项目的官方源码托管仓库、版本发布与 Issue 跟踪。 + 查看 AutoLibrary 源码和开发进展。 - 获取 AutoLibrary 最新版本安装包。 + 查看可用的 AutoLibrary 安装包。 - 国内自托管镜像仓库，提供更快的访问与其它个性化内容。 + 查看手册源码或提交文档修改。 - - Gitea 镜像仓库与 GitHub 主仓库的同步间隔为 8 小时，因此提交的不一致问题是正常的，请等待 - Gitea 镜像仓库同步后再次检查。 - - ## 问题反馈 如果在使用 AutoLibrary 过程中遇到了一些问题，并且无法在本文档站点中寻找到任何解决方法； 亦或者是对 AutoLibrary 有一些自己的意见和建议，欢迎通过下面的各种渠道与我们取得联系 -### GitHub Issues +### Gitea Issues -使用过程中遇到问题或需要功能改进，请通过 GitHub Issues 提交反馈： +使用过程中遇到问题或需要功能改进，请通过 Gitea Issues 提交反馈。 提交 Bug 报告或功能请求前，请先搜索是否已有相关问题，避免重复提交。 @@ -73,19 +67,10 @@ description: "AutoLibrary 的相关链接，以及快速获取联系我们的方 ## 参与贡献 -欢迎通过以下方式参与 AutoLibrary 项目，AutoLibrary 通过 [MIT 协议](https://github.com/KenanZhu/AutoLibrary/blob/main/license) 进行开源，你可以对 AutoLibrary 自由的修改并再次分发： +### 参与主项目 - - - 在 [GitHub](https://github.com/KenanZhu/AutoLibrary) 或 [Gitea](https://gitea.kenanzhu.com/KenanZhu/AutoLibrary) 上 Fork 项目仓库至个人账号。 - - - 基于 main 分支创建特性分支。 - - - 编写清晰规范的提交信息，推送到 Fork 仓库。 - - - 向主仓库发起 [Pull Request](https://github.com/KenanZhu/AutoLibrary/pulls)，描述修改内容与目的。 - - +AutoLibrary 采用 [MIT 许可证](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/LICENSE)。如果你想贡献代码，请先在 [Gitea Issues](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues) 说明你想解决的问题和拟议改动，与维护者讨论提交方式。 + +### 改进用户手册 + +如果你想修正或补充手册内容，请在 [GitLab 手册仓库](https://gitlab.com/KenanZhu/AutoLibraryManuals) 修改对应的 `.mdx` 文件，然后提交 [Merge Request](https://gitlab.com/KenanZhu/AutoLibraryManuals/-/merge_requests)。 diff --git a/zh/manual/v1.3.0/installation/install.mdx b/zh/manual/v1.3.0/installation/install.mdx index 1b57c07..013ff9b 100644 --- a/zh/manual/v1.3.0/installation/install.mdx +++ b/zh/manual/v1.3.0/installation/install.mdx @@ -11,12 +11,10 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具 ## 下载软件 -请从 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads)获取最新版本。 +请在 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 查看可用的安装包。 - [**GitHub Releases**](https://github.com/KenanZhu/AutoLibrary/releases)：更新较为及时，但网络连接不稳定，速度较慢。 - - **云盘链接**：版本更新略有延迟，但下载速度更快。 + 你也可以在 [Gitea 发布页](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/releases) 查看主仓库的发布记录。 ## 安装类型 diff --git a/zh/manual/v1.4.0/faq/contact.mdx b/zh/manual/v1.4.0/faq/contact.mdx index afab81c..7c887d4 100644 --- a/zh/manual/v1.4.0/faq/contact.mdx +++ b/zh/manual/v1.4.0/faq/contact.mdx @@ -5,30 +5,29 @@ description: "AutoLibrary 的相关链接，以及快速获取联系我们的方 ## 相关链接 -下列是快速获取与 AutoLibrary 相关的最新信息的方式，你可以跟踪最新的开发进展 -以及未来的开发规划 +你可以在这里查看 AutoLibrary 源码、下载软件和参与手册维护。 - 项目的官方源码托管仓库、版本发布与 Issue 跟踪。 + 查看 AutoLibrary 源码和开发进展。 - 自托管镜像仓库，提供更快的访问与其它个性化内容。 + 查看手册源码或提交文档修改。 - 获取 AutoLibrary 最新版本安装包。 + 查看可用的 AutoLibrary 安装包。 - - Gitea 镜像仓库与 GitHub 主仓库的同步间隔为 8 小时，因此出现提交不一致的问题是正常的， - 请等待 Gitea 镜像仓库同步后再次检查。 - - ## 问题反馈 如果在使用 AutoLibrary 过程中遇到了一些问题，并且无法在本文档站点中寻找到任何解决方法； 亦或者是对 AutoLibrary 有一些自己的意见和建议，欢迎通过下面的各种渠道与我们取得联系 -### GitHub Issues +### Gitea Issues -使用过程中遇到问题或需要功能改进，请通过 GitHub Issues 提交反馈： +使用过程中遇到问题或需要功能改进，请通过 Gitea Issues 提交反馈。 提交 Bug 报告或功能请求前，请先搜索是否已有相关问题，避免重复提交。 @@ -73,23 +67,10 @@ description: "AutoLibrary 的相关链接，以及快速获取联系我们的方 ## 参与贡献 -欢迎通过以下方式参与 AutoLibrary 项目，AutoLibrary 通过 [MIT 协议](https://github.com/KenanZhu/AutoLibrary/blob/main/license) 进行开源，你可以对 AutoLibrary 自由的修改并再次分发： +### 参与主项目 - - 请通过 GitHub 主仓库提交 PR。Gitea 镜像仅用于数据同步备份，不参与代码贡献流程。 - +AutoLibrary 采用 [MIT 许可证](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/LICENSE)。如果你想贡献代码，请先在 [Gitea Issues](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues) 说明你想解决的问题和拟议改动，与维护者讨论提交方式。 - - - 在 [GitHub](https://github.com/KenanZhu/AutoLibrary) 上 Fork 项目仓库至个人账号。 - - - 基于 main 分支创建特性分支。 - - - 编写清晰规范的提交信息，推送到 Fork 仓库。 - - - 向主仓库发起 [Pull Request](https://github.com/KenanZhu/AutoLibrary/pulls)，描述修改内容与目的。 - - +### 改进用户手册 + +如果你想修正或补充手册内容，请在 [GitLab 手册仓库](https://gitlab.com/KenanZhu/AutoLibraryManuals) 修改对应的 `.mdx` 文件，然后提交 [Merge Request](https://gitlab.com/KenanZhu/AutoLibraryManuals/-/merge_requests)。 diff --git a/zh/manual/v1.4.0/installation/install.mdx b/zh/manual/v1.4.0/installation/install.mdx index 9c874af..7778f45 100644 --- a/zh/manual/v1.4.0/installation/install.mdx +++ b/zh/manual/v1.4.0/installation/install.mdx @@ -7,12 +7,10 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具 ## 下载软件 -请从 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 获取最新版本。 +请在 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 查看可用的安装包。 - [**GitHub Releases**](https://github.com/KenanZhu/AutoLibrary/releases)：更新较为及时，但网络连接不稳定，速度较慢。 - - **云盘链接**：版本更新略有延迟，但下载速度更快。 + 你也可以在 [Gitea 发布页](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/releases) 查看主仓库的发布记录。 ## 安装类型 @@ -47,7 +45,7 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具 从下载页面获取 `AutoLibrary.<版本号>-macos-arm64.dmg` 文件。 - 目前仅提供 Apple Silicon (M 系列芯片) 版本。如果你使用 Intel 芯片的 Mac，请从源码自行构建，详见 [GitHub 仓库](https://github.com/KenanZhu/AutoLibrary) README 中的构建说明。 + 目前仅提供 Apple Silicon (M 系列芯片) 版本。如果你使用 Intel 芯片的 Mac，请按 [Gitea 仓库 README](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/README.md) 中的说明从源码构建。