docs: add readme for docs repo (#1562)

* docs: add readme for docs repo

* fix sentence style heading

* change search provider to local
This commit is contained in:
Calvin W. 2025-07-17 14:37:07 +08:00 committed by GitHub
parent af8e3b172c
commit ea0404fe2b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 61 additions and 14 deletions

View file

@ -113,7 +113,7 @@ This section lists the main directories in the Olares repository:
* **[`apps`](./apps)**: Contains the code for system applications, primarily for `larepass`.
* **[`cli`](./cli)**: Contains the code for `olares-cli`, the command-line interface tool for Olares.
* **[`daemon`](./daemon)**: Contains the code for `olaresd`, the system daemon process.
* **`docs`**: Contains documentation for the project.
* **[`docs`**](./docs): Contains documentation for the project.
* **[`framework`](./framework)**: Contains the Olares system services.
* **[`infrastructure`](./infrastructure)**: Contains code related to infrastructure components such as computing, storage, networking, and GPUs.
* **[`platform`](./platform)**: Contains code for cloud-native components like databases and message queues.

View file

@ -115,7 +115,7 @@ Olares 代码库中的主要目录如下:
* **[`apps`](./apps)**: 用于存放系统应用,主要是 `larepass` 的代码。
* **[`cli`](./cli)**: 用于存放 `olares-cli`Olares 的命令行界面工具)的代码。
* **[`daemon`](./daemon)**: 用于存放 `olaresd`(系统守护进程)的代码。
* **`docs`**: 用于存放 Olares 项目的文档。
* **[`docs`**](./docs): 用于存放 Olares 项目的文档。
* **[`framework`](./framework)**: 用来存放 Olares 系统服务代码。
* **[`infrastructure`](./infrastructure)**: 用于存放计算存储网络GPU 等基础设施的代码。
* **[`platform`](./platform)**: 用于存放数据库、消息队列等云原生组件的代码。

View file

@ -115,7 +115,7 @@ Olaresは以下のLinuxプラットフォームで動作検証を完了してい
* **[`apps`](./apps)**: システムアプリケーションのコードが含まれており、主に `larepass` 用です。
* **[`cli`](./cli)**: Olares のコマンドラインインターフェースツールである `olares-cli` のコードが含まれています。
* **[`daemon`](./daemon)**: システムデーモンプロセスである `olaresd` のコードが含まれています。
* **`docs`**: プロジェクトのドキュメントが含まれています。
* **[`docs`](./docs)**: プロジェクトのドキュメントが含まれています。
* **[`framework`](./framework)**: Olares システムサービスが含まれています。
* **[`infrastructure`](./infrastructure)**: コンピューティング、ストレージ、ネットワーキング、GPU などのインフラストラクチャコンポーネントに関連するコードが含まれています。
* **[`platform`](./platform)**: データベースやメッセージキューなどのクラウドネイティブコンポーネントのコードが含まれています。

View file

@ -57,14 +57,9 @@ export default defineVersionedConfig2(withMermaid({
},
themeConfig: {
search: {
provider: "algolia",
provider: "local",
options: {
appId: "DZ6H2FVQGO",
apiKey: "e5257d88b605dc0e5b82b12854aea9a5",
indexName: "olares",
searchParameters: {
queryLanguages: ["zh", "en"],
},
enhancedSearch: true,
locales: {
zh: {
placeholder: "搜索文档",

View file

@ -1,10 +1,62 @@
# Olares Docs
# Olares documentation
## Run
Welcome to the source repository for the official Olares documentation!
```shell
This directory includes the source files for the Olares documentation website, instructions for setting up the project locally, Markdown references, and style guides to ensure consistency and quality across all documentation.
## Quick links
* **Published documentation site**: `https://docs.olares.com`
* **Olares official website**: `https://www.olares.com`
* **Olares project on GitHub**: `https://github.com/olares/olares`
## Getting started with Olares documentation
We welcome community contributions! Follow these steps to preview, develop, and build the documentation locally.
### Install dependencies
First, ensure you have [Node.js](https://nodejs.org/) installed (LTS version recommended). Then, run the following command in the project's root directory to install the required dependencies:
```bash
npm install
````
### Start the development server
Start the local development server with hot-reloading. This allows you to see your changes live in the browser as you edit the source files.
```bash
npm run dev
```
Open Browser at `http://localhost:5173/`
Once running, open your browser and navigate to `http://localhost:5173/` to see the local preview.
### Build the site locally
To generate a production-ready build for final review or debugging, run:
```bash
npm run build
```
This command will build the static site into the `dist` directory.
## Versioning and branching strategy
To manage documentation for different product versions effectively, we use the following branching strategy:
* **`main` branch**:
This branch contains the latest documentation for the **next, in-development version** of Olares. All documentation for new features should be submitted here.
* **`release-{version}` branch**:
These branches hold the documentation for **recent, stable versions**. For example, the `release-1.11` branch corresponds to the `Olares 1.11` documentation. Fixes or clarifications for a specific stable version should be submitted to its corresponding release branch.
Creating a PR to a corresponding branch will automatically trigger the documentation build for that version.
## Style guide
To ensure clarity, accuracy, and a consistent tone, please read our **[Content and Style Guide](https://github.com/beclab/docs/wiki/Markdown-reference)** before contributing.
```
```