Skip to content

Commit d30fb88

Browse files
committed
tweak content and fix links
1 parent 7908905 commit d30fb88

38 files changed

+92
-91
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Terminus Docs
1+
# Olares Docs
22

33
## Run
44

docs/.vitepress/config.mts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default withMermaid({
2424
options: {
2525
appId: "0614S1555J",
2626
apiKey: "cbf4702e9d6bfb5a0ae85bf0d486a591",
27-
indexName: "olares",
27+
indexName: "jointerminus",
2828
locales: {
2929
zh: {
3030
placeholder: "搜索文档",

docs/.vitepress/en.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ const side = {
287287
text: "Back up and restore",
288288
link: "/manual/space/backup-restore",
289289
},
290-
{ text: "Billing", link: "/manual/billing" },
290+
{ text: "Billing", link: "/manual/space/billing" },
291291
],
292292
},
293293
{
@@ -497,7 +497,7 @@ const side = {
497497
export const en = defineConfig({
498498
lang: "/",
499499
themeConfig: {
500-
logo: "/icon.png",
500+
//logo: "/icon.png",
501501
socialLinks: [{ icon: "github", link: "https://github.com/beclab" }],
502502

503503
nav: [

docs/developer/contribute/system-app/deployment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The system application need to be installed under the `user-space` namespace. Th
2828
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
2929
applications.app.bytetrade.io/author: bytetrade.io
3030
annotations:
31-
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon. png
31+
applications.app.bytetrade.io/icon: https://docs-dev.olares.xyz/icon. png
3232
applications.app.bytetrade.io/title: Desktop-dev
3333
applications.app.bytetrade.io/version: '0.0.1'
3434
@@ -123,7 +123,7 @@ metadata:
123123
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
124124
applications.app.bytetrade.io/author: bytetrade.io
125125
annotations:
126-
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon.png
126+
applications.app.bytetrade.io/icon: https://docs-dev.olares.xyz/icon.png
127127
applications.app.bytetrade.io/title: Desktop-dev
128128
applications.app.bytetrade.io/version: '0.0.1'
129129
applications.app.bytetrade.io/entrances: '[{"name":"desktop-frontend-dev", "host":"desktop-svc-dev", "port":80,"title":"Desktop-dev"}]'

docs/developer/develop/advanced/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ cd install-wizard && bash change_ip.sh
4242
This command is not applicable to Olares on macOS yet.
4343
:::
4444

45-
## Add a Olares node locally
45+
## Add an Olares node locally
4646

4747
**Before Install**
4848
- Get the `internal IP address` of the **Master** node.

docs/developer/develop/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Developing applications on **Olares** is not much different from regular website
99
- [Extensions field to Helm in Olares](./package/extension.md)
1010

1111
- [Exploring Our Tutorials](./tutorial/)
12-
- [Learn about Devbox, a Olares Development Tool](./tutorial/devbox.md)
12+
- [Learn about Devbox, an Olares Development Tool](./tutorial/devbox.md)
1313
- [Creating your first application](./tutorial/note/)
1414
- [Exploring Advanced Concepts](./advanced/)
1515
- [Submitting Applications to the Olares Market](./submit/)

docs/developer/develop/package/manifest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ outline: [2, 3]
44

55
# OlaresManifest Specification
66

7-
Every **Olares Application Chart** should include a `OlaresManifest.yaml` file in the root directory. `OlaresManifest.yaml` provides all the essential information about a Olares App. Both the **Olares Market protocol** and the **Olares** depend on this information to distribute and install applications.
7+
Every **Olares Application Chart** should include a `OlaresManifest.yaml` file in the root directory. `OlaresManifest.yaml` provides all the essential information about an Olares App. Both the **Olares Market protocol** and the **Olares** depend on this information to distribute and install applications.
88

99
Here's an example of what a `OlaresManifest.yaml` file might look like:
1010

docs/developer/develop/tutorial/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tutorial
22

3-
Welcome to the Olares developer guides. These detailed tutorials offer a step-by-step guide on building a Olares Application from scratch.
3+
Welcome to the Olares developer guides. These detailed tutorials offer a step-by-step guide on building an Olares Application from scratch.
44

55
To get started, you can learn some basic concepts of Olares, such as:
66
- [Olares architectural components](../../../manual/concepts/architecture)

docs/developer/develop/tutorial/note/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-
77
The tutorial includes three parts:
88

99
1. [Create an App](./create.md)<br>
10-
This section provides a step-by-step guide on how to create a Olares App and set up the initial development environment.
10+
This section provides a step-by-step guide on how to create an Olares App and set up the initial development environment.
1111

1212
2. [Backend Development](./backend.md)<br>
1313
In this section, you'll learn how to use DevBox's IDE to develop the backend programs in `Golang` and provide API interfaces for the frontend.

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ hero:
88
actions:
99
- theme: brand
1010
text: What is Olares?
11-
link: /overview/introduction/what-is-olares
11+
link: /manual/feature-overview.html
1212
- theme: alt
1313
text: Get Started
14-
link: /overview/introduction/
14+
link: /manual/get-started/
1515
- theme: alt
1616
text: GitHub
1717
link: https://github.com/beclab/olares

docs/manual/docs-home.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Olares (formerly Terminus) is a free, source-available, cloud-native operating s
44

55
For a comprehensive overview of the system, visit our [GitHub repository](https://github.com/beclab/olares).
66

7+
:::info Note
8+
Screenshots are being updated to reflect our new branding. Screenshots may differ slightly from UI elements referred.
9+
:::
10+
711
## New to Olares?
812

913
The getting-started guide covers creating an Olares ID and setting up Olares on your local machine.

docs/manual/feature-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Olares offers a wide array of features designed to enhance security, ease of use, and development flexibility:
44

55
- **Enterprise-grade security**: Simplified network configuration using Tailscale, Headscale, Cloudflare Tunnel, and FRP.
6-
- **Secure and permissionless application ecosystem**: Sandboxing ensures application isolation and security.
6+
- **Secure and permissionless application ecosystem**: Sandboxing ensures application isolation and security. [See what Olares Market has to offer](https://market.olares.xyz/).
77
- **Unified file system and database**: Automated scaling, backups, and high availability.
88
- **Single sign-on**: Log in once to access all applications within Olares with a shared authentication service.
99
- **AI capabilities**: Comprehensive solution for GPU management, local AI model hosting, and private knowledge bases while maintaining data privacy.

docs/manual/get-started/back-up-mnemonics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ After setting up, you can choose to enable biometric unlock for more secure and
2525
6. Securely record the mnemonic phrase and store it in a safe place.
2626
7. Click **Next**.
2727
:::warning
28-
While clicking Copy will save the mnemonic phrase to your clipboard, this poses a security risk. For maximum security, we strongly recommend backing up your mnemonic phrase offline. :::
28+
While clicking **Copy** will save the mnemonic phrase to your clipboard, this poses a security risk. For maximum security, we strongly recommend backing up your mnemonic phrase offline.
2929
:::
3030
8. Verify your backup by arranging the mnemonic phrase in the correct order.
3131
9. Click **Completed**.
@@ -48,4 +48,4 @@ If you encounter a password error, it may be because you haven't set a local pas
4848

4949
## Congratulations!
5050
And now you're ready to discover Olares further:
51-
- [Next steps](./next-steps.md)
51+
- [What's next](./next-steps.md)

docs/manual/get-started/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
55
:::
66

77
<div class="cta">
8-
<a href="./get-started/">
8+
<a href="../create-olares-id">
99
<div class="content">
1010
<h3>First time using Olares?</h3>
1111
<p>Learn how to create an Olares ID, and get your Olares up and running.</p>
@@ -15,7 +15,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
1515
</div>
1616

1717
<div class="cta">
18-
<a href="./get-started/">
18+
<a href="../../tasks/">
1919
<div class="content">
2020
<h3>Already have an Olares?</h3>
2121
<p>Explore our comprehensive how-to guide covering every aspect of Olares.</p>
@@ -25,7 +25,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
2525
</div>
2626

2727
<div class="cta">
28-
<a href="./get-started/">
28+
<a href="../../../tasks/team">
2929
<div class="content">
3030
<h3>Team up in Olares?</h3>
3131
<p>Discover how to leverage Olares for collaborative work and team management.</p>

docs/manual/get-started/install-olares.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -287,5 +287,5 @@ Upon completion of the installation, the initial system information, including t
287287
![alt text](/images/how-to/olares/one_time_password.png)
288288

289289
## Next step
290-
290+
Now that you have installed Olares, the next step is to activate your system for use, similar to setting up a new smartphone:
291291
- [Activate Olares](./activate-olares)

docs/manual/get-started/next-steps.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# What's next
22

3-
Congratulations! You're now ready to dive into Olares's powerful features. You will find it easy to get things done in Olares.
3+
You're now ready to dive into Olares's powerful features. You will find it easy to get things done in Olares.
44

55
Here are some suggested next steps:
66

@@ -44,13 +44,13 @@ Here are some suggested next steps:
4444
description="Deepen your understanding of Olares."
4545
:links="[
4646
{ text: 'Olares core components',
47-
href: 'placeholder' },
47+
href: '../concepts/architecture' },
4848
{ text: 'Olares ID',
49-
href: 'placeholder' },
49+
href: '../concepts/olares-id' },
50+
{ text: 'Account',
51+
href: '../concepts/account' },
5052
{ text: 'Application',
51-
href: 'placeholder' },
52-
{ text: 'Recommend',
53-
href: 'placeholder' }]"
53+
href: '../concepts/application' },]"
5454
buttonText="Learn more"
5555
buttonLink="../concepts/"
5656
/>

docs/manual/help/faqs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Olares consists of a series of projects using a hierarchical authorization appro
66

77
- Projects running on blockchain use Apache 2.0, such as [Snowinning Protocol](https://github.com/beclab/olaresdid-contract-system).
88
- Projects related to protocols use Apache 2.0, such as [r4](https://github.com/beclab/r4).
9-
- Projects around [Olares](https://github.com/beclab/olares) and [LarePass](https://github.com/beclab/LarePass) use the [Olares License](https://github.com/beclab/Olares/blob/main/LICENSE.md).
9+
- Projects around Olares and LarePass use the [Olares License](https://github.com/beclab/Olares/blob/main/LICENSE.md).
1010
- For third-party applications running on Olares, it is up to the developer to decide whether they want them open source or not and choose the license accordingly.
1111

1212
For more details, visit our projects on [GitHub](https://github.com/beclab).
@@ -43,7 +43,7 @@ Meanwhile, Olares aims to provide a one-stop self-hosted solution, which goes be
4343

4444
## I have several servers. Can I use Olares to manage them one-stop?
4545

46-
Yes. You can refer to [How to add a node](../../developer/develop/advanced/cli#add-a-olares-node-locally).
46+
Yes. You can refer to [How to add a node](../../developer/develop/advanced/cli#add-an-olares-node-locally).
4747

4848
After you add the node, you can manage the cluster via [Dashboard](../tasks/resources-usage) and [Control Hub](../tasks/navigate-control-hub).
4949

@@ -100,7 +100,7 @@ However, there are chances that applications developed through this method canno
100100

101101
We use the term Olares under two scenarios:
102102

103-
- Describing the entire project and the OS. Specifically, it refers to the complete architecture including 3 core components and extension protocols.
103+
- Describing the entire project and the operating system. Specifically, it refers to the complete architecture including 3 core components and extension protocols.
104104
- Describing the hardware devices running Olares. Be it a Raspberry Pi or a cluster of multiple machines on the cloud, all can be called Olares.
105105

106106

docs/manual/space/host-domain.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Now that your organization has a verified domain name, you or other members you
5656

5757
![org-olares-id](/images/how-to/larepass/organization_olares_id.png)
5858

59-
1. In LarePass app, navigate to **Organization Olares ID** > **Join an existing organization**.
59+
1. In the LarePass app, navigate to **Organization Olares ID** > **Join an existing organization**.
6060
2. Enter your organization's domain name and click **Continue**. Recheck whether your domain name has been verified and configured if an error occurs.
6161
3. Bind the VC via your email accounts. Currently, only Gmail and Google Workspace email are supported.
6262

63-
Upon completion, you will receive an Organization Olares ID. Now you can go ahead to [Activate Olares](../get-started/activate-olares)
63+
Upon completion, you will receive an Organization Olares ID. Now you can go ahead to [Activate Olares](../get-started/activate-olares).
6464

6565
## Domain status and processing
6666

docs/manual/space/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This section walks you through usages of Olares Space, covering:
1414
- [Manage Olares](manage-olares.md)
1515
- [Host custom domains](host-domain.md)
1616
- [Manage organization domains](manage-domain.md)
17-
- [Backup & Restore Olares](backup-restore.md)
17+
- [Back up & Restore Olares](backup-restore.md)
1818
- [Usage and Billing](billing.md)
1919

2020

docs/manual/space/manage-accounts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide walks you through common account operations with Olares Space, includ
66

77
Olares Space uses a decentralized ID (DID) or Olares ID for authentication. Make sure you already have obtained your credentials on your LarePass.
88

9-
1. In LarePass app, select the DID or Olares ID you wish to use to log in.
9+
1. In the LarePass app, select the DID or Olares ID you wish to use to log in.
1010
2. Open https://space.olares.xyz/ in your browser.
1111
3. Scan the QR code using LarePass.
1212

docs/manual/space/manage-olares.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Currently, we do not offer cloud instances that include GPUs. However, for users
4848
For Large Language Models (LLMs), the shared GPU solution is still under development and may require further enhancements.
4949
:::
5050

51-
If you need GPU support, please [contact us](mailto:support@olares.com) for more information.
51+
If you need GPU support, please reach us on [Discord](https://discord.com/invite/BzfqrgQPDK).

docs/manual/tasks/access-settings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can access Olares applications anytime, anywhere, whether you're accessing f
77
- Personalize domain name for your applications
88
- Allow public access without authentication
99

10-
## Before you start
10+
## Before you begin
1111
Before you start, it is recommended to familiarize yourself with a few concepts for Olares applications:
1212

1313
- [Endpoints](../concepts/network.md#endpoints)

docs/manual/tasks/files.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ It consists of three main components:
1616

1717
---
1818
<div>
19-
<h4><a href="./add-edit-download/">Add, edit, and download files</a></h4>
19+
<h4><a href="./add-edit-download">Add, edit, and download files</a></h4>
2020
Learn the fundamentals of file management in Olares.
2121
</div>
2222

2323
<div>
24-
<h4><a href="./sync-share/">Sync and share files</a></h4>
24+
<h4><a href="./sync-share">Sync and share files</a></h4>
2525
Learn how to keep files updated across devices, and how to share files with other Olares member.
2626
</div>
2727

0 commit comments

Comments
 (0)