|
1 | | -# Start9 Documentation |
| 1 | +# StartOS Docs |
2 | 2 |
|
3 | | -Welcome to the Start9 Docs! Here you will find the StartOS user manual, as well as integration guides, FAQ, support, knowledge base, and developer docs. |
| 3 | +The official documentation for [StartOS](https://start9.com) — covering setup, services, networking, troubleshooting, developer guides, and more. |
4 | 4 |
|
5 | | -## Dependencies |
| 5 | +**Live site:** [docs.start9.com](https://docs.start9.com) |
6 | 6 |
|
7 | | -1. [node](https://nodejs.org/en/) |
| 7 | +## Overview |
8 | 8 |
|
9 | | -2. [npm](https://www.npmjs.com/get-npm) |
10 | | - |
11 | | -3. Rust |
| 9 | +Built with [mdBook](https://rust-lang.github.io/mdBook/) and deployed to GitHub Pages. Includes an embedded [Start Bot](widget/) chat widget that provides AI-powered support using RAG (retrieval-augmented generation) over the documentation content. |
12 | 10 |
|
13 | | - ``` |
14 | | - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh |
15 | | - ``` |
| 11 | +## How It Works |
16 | 12 |
|
17 | | -4. [mdBook](https://rust-lang.github.io/mdBook/) - Documentation framework |
18 | | - |
19 | | - ``` |
20 | | - cargo install mdbook |
21 | | - ``` |
| 13 | +- Documentation is written in Markdown under `src/` |
| 14 | +- On push to `master`, GitHub Actions builds the site, deploys to Pages, and indexes the content for Start Bot |
| 15 | +- The indexing step chunks the Markdown by headings, generates vector embeddings via [Voyage AI](https://www.voyageai.com/), and sends them to the [start9-me](https://github.com/Start9Labs/start9-me) server for semantic search |
22 | 16 |
|
23 | | -## Building |
| 17 | +## Getting Started |
24 | 18 |
|
25 | | -1. Clone the repo and change into its directory |
26 | | - |
27 | | - ``` |
28 | | - git clone https://github.com/Start9Labs/docs.git && cd docs |
29 | | - ``` |
30 | | - |
31 | | -2. Run the serve script |
32 | | - |
33 | | - ``` |
34 | | - ./serve |
35 | | - ``` |
36 | | - |
37 | | - This will automatically build the project and open your default web browser at http://localhost:3000 |
38 | | - |
39 | | -## Contributing |
40 | | - |
41 | | -We love contributions! Whether you spot a typo or want to make suggestions, you can fork this project and submit a PR with your changes for consideration. If you are uncomfortable with this process, please [create an issue](https://github.com/Start9Labs/docs/issues). |
42 | | - |
43 | | -If you'd like to get started contributing to open source software, it's easier than you think! Visit one of our [Community Channels](https://start9.com/contact) and we'll help you get started. |
44 | | - |
45 | | -## Third party plugins |
46 | | - |
47 | | -[External link to plugins](https://github.com/rust-lang/mdBook/wiki/Third-party-plugins) |
| 19 | +See [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup and contribution guidelines. |
0 commit comments