Olares Documentation

File: docs/index.md Copy Chapter

https://vitepress.dev/reference/default-theme-home-page

layout: home

/docs/ 301-redirects to /manual/overview (see theme/redirects.ts), so keep this

redirecting URL out of the sitemap and search index.

noindex: true

hero:
name: "Olares"
text: "An open-source personal cloud OS"
tagline: "Let people own their data again"
actions:

• theme: brand
  text: What is Olares?
  link: /manual/overview
• theme: alt
  text: Star us on GitHub
  link: https://github.com/beclab/olares

features:

• icon: 🚀
  title: Get started with Olares
  details: Install Olares on your hardware and begin taking control of your data in minutes.
  link: /manual/get-started/

• icon: ⚙️
  title: Master your system
  details: Dive into Olares' system apps to configure, personalize, and access your personal cloud.
  link: /manual/olares/

• icon: 📱
  title: Hands-on with LarePass
  details: Securely access and manage your Olares from LarePass, the cross-platform client for Olares.
  link: /manual/larepass/

• icon: 💡
  title: Explore Use Cases
  details: Discover various ways you can leverage Olares in daily life with real-life tutorials and use cases.
  link: /use-cases/

File: docs/README.md Copy Chapter

Olares documentation

Welcome to the source repository for the official Olares documentation!

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 Copy Chapter

• Published documentation site: https://docs.olares.com
• Olares official website: https://www.olares.com
• Olares project on GitHub: https://github.com/beclab/Olares

Getting started with Olares documentation Copy Chapter

We welcome community contributions! Follow these steps to preview, develop, and build the documentation locally.

Install dependencies Copy Section

First, ensure you have Node.js installed (LTS version recommended). Then, run the following command in the project's root directory to install the required dependencies:

npm install

Start the development server Copy Section

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.

npm run dev

Once running, open your browser and navigate to http://localhost:5173/ to see the local preview.

Build the site locally Copy Section

To generate a production-ready build for final review or debugging, run:

npm run build

This command will build the static site into the dist directory.

Document share previews Copy Section

Production builds automatically generate a separate share image for each page.
Images are included in .vitepress/dist/og/ and deployed with the site.
See share image configuration for the template,
font licenses, preview URLs, and optional ogTitle frontmatter.

Versioning and branching strategy Copy Chapter

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 Copy Chapter

To ensure clarity, accuracy, and a consistent tone, please read our Content and style guide before contributing.