Skip to content

Commit 9afaaab

Browse files
committed
update for latest start9 me
1 parent aee808f commit 9afaaab

5 files changed

Lines changed: 74 additions & 44 deletions

File tree

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing
2+
3+
We welcome contributions! Whether you spot a typo or want to suggest new content, you can fork this project and submit a PR. If you are uncomfortable with this process, please [create an issue](https://github.com/Start9Labs/docs/issues).
4+
5+
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.
6+
7+
## Local Development
8+
9+
1. Install dependencies
10+
11+
[Rust](https://rustup.rs)
12+
13+
```
14+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
15+
```
16+
17+
[mdBook](https://rust-lang.github.io/mdBook/)
18+
19+
```
20+
cargo install mdbook
21+
```
22+
23+
2. Clone the repo
24+
25+
```
26+
git clone https://github.com/Start9Labs/docs.git && cd docs
27+
```
28+
29+
3. Serve locally
30+
31+
```
32+
./serve.sh
33+
```
34+
35+
This builds the project and opens your browser at http://localhost:3000.
36+
37+
## Project Structure
38+
39+
```
40+
docs/
41+
├── src/ # Markdown source files (the actual documentation)
42+
├── theme/ # Custom CSS and JS (styling, Start Bot widget)
43+
├── widget/ # Start Bot chat widget (TypeScript, built by CI)
44+
├── scripts/ # Documentation indexing script for RAG
45+
├── book.toml # mdBook configuration
46+
└── serve.sh # Local development server
47+
```
48+
49+
## Writing Docs
50+
51+
- All documentation lives in `src/` as Markdown files
52+
- The sidebar structure is defined in `src/SUMMARY.md`
53+
- mdBook supports [admonitions](https://tommilligan.github.io/mdbook-admonish/) for warnings, tips, etc.
54+
- Use relative links between pages
55+
56+
## Third Party Plugins
57+
58+
[External link to mdBook plugins](https://github.com/rust-lang/mdBook/wiki/Third-party-plugins)

README.md

Lines changed: 11 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,19 @@
1-
# Start9 Documentation
1+
# StartOS Docs
22

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.
44

5-
## Dependencies
5+
**Live site:** [docs.start9.com](https://docs.start9.com)
66

7-
1. [node](https://nodejs.org/en/)
7+
## Overview
88

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.
1210

13-
```
14-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
15-
```
11+
## How It Works
1612

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
2216

23-
## Building
17+
## Getting Started
2418

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.

scripts/index-docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export {};
22

33
/**
4-
* Index StartOS documentation for AIDN
4+
* Index StartOS documentation for Start Bot
55
*
66
* This script goes in the docs repo at scripts/index-docs.ts
77
*

theme/docs-agent-init.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Start9 Docs Agent Widget Configuration
22
window.DocsAgentConfig = {
3-
apiBaseUrl: 'https://start9.me/_api/docs',
3+
apiBaseUrl: 'https://start9.me/_api/chat',
44
position: 'bottom-right'
55
};

widget/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ class DocsAgentWidget {
271271
return `
272272
<div class="da-panel">
273273
<div class="da-header">
274-
<span class="da-title">AIDN</span>
274+
<span class="da-title">Start Bot</span>
275275
<div class="da-header-actions">
276276
${
277277
this.session
@@ -314,7 +314,7 @@ class DocsAgentWidget {
314314
<path d="M19 17v4"/>
315315
<path d="M17 19h4"/>
316316
</svg>
317-
<h3>Meet AIDN</h3>
317+
<h3>Meet Start Bot</h3>
318318
<p>Your AI assistant for all things StartOS. Enter your support access code to start chatting.</p>
319319
</div>
320320
<form class="da-code-form">
@@ -337,7 +337,7 @@ class DocsAgentWidget {
337337
const messagesHtml =
338338
this.messages.length === 0
339339
? `<div class="da-welcome">
340-
<p>Hi, I'm AIDN. Ask me anything about StartOS.</p>
340+
<p>Hi, I'm Start Bot. Ask me anything about StartOS.</p>
341341
</div>`
342342
: this.messages.map((m) => this.renderMessage(m)).join("");
343343

0 commit comments

Comments
 (0)