Skip to content

Commit 9f22c59

Browse files
committed
more cleanup
1 parent b77b24d commit 9f22c59

4 files changed

Lines changed: 4 additions & 44 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HexOS Documentation
22

3-
This repo contains a VitePress site for HexOS docs: Install Scripts, TrueNAS integration, platform internals, and curated JSON downloads.
3+
This repo contains the docs for guides, install scripts, and more.
44

55
## Quick start
66
```bash

docs/.vitepress/sidebar.ts

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
11
import type { DefaultTheme } from 'vitepress'
22

33
const sidebar: DefaultTheme.Sidebar = {
4-
'/getting-started/': [
5-
{
6-
text: 'Getting Started',
7-
items: [
8-
{ text: 'Overview', link: '/getting-started/' },
9-
{ text: 'Prerequisites', link: '/getting-started/prerequisites' }
10-
]
11-
}
12-
],
13-
'/truenas-integration/': [
14-
{
15-
text: 'TrueNAS Integration',
16-
items: [
17-
{ text: 'Overview', link: '/truenas-integration/' },
18-
{ text: 'API', link: '/truenas-integration/api' },
19-
{ text: 'app.create', link: '/truenas-integration/app-create' }
20-
]
21-
}
22-
],
234
'/install-scripts/': [
245
{
256
text: 'Install Scripts',
@@ -28,33 +9,13 @@ const sidebar: DefaultTheme.Sidebar = {
289
{ text: 'Quickstart', link: '/install-scripts/quickstart' },
2910
{ text: 'Contributors Guide', link: '/install-scripts/contributing' },
3011
{ text: 'Reference: Schema', link: '/install-scripts/reference/schema' },
31-
{ text: 'Reference: Macros', link: '/install-scripts/reference/macros' },
3212
{ text: 'Reference: Pipeline', link: '/install-scripts/reference/pipeline' },
3313
{ text: 'Apps (Curated Scripts)', link: '/install-scripts/curated/' },
3414

3515

3616
]
3717
}
3818
],
39-
'/platform/': [
40-
{
41-
text: 'Platform Internals',
42-
items: [
43-
{ text: 'Tasks', link: '/platform/tasks' },
44-
{ text: 'Preferences', link: '/platform/preferences' },
45-
{ text: 'Permissions', link: '/platform/permissions' }
46-
]
47-
}
48-
],
49-
'/contributing/': [
50-
{
51-
text: 'Contributing',
52-
items: [
53-
{ text: 'How to Contribute', link: '/contributing/' },
54-
{ text: 'Style Guide', link: '/contributing/style-guide' }
55-
]
56-
}
57-
],
5819
'/': [
5920
{
6021
text: 'Documentation',

docs/install-scripts/overview.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
We have consolidated the curation of apps from our codebase to an install script format. Install scripts let you describe storage, permissions, and app values in one JSON. We have also brought an interface to the HexOS frontend to help iterate on these apps and allow the community to supply their own curations or amend existing if they would like. The tools are available now on dev-deck. Enable dev mode from preferences and you will have access to the "Custom Script" option for installing apps. You can modify existing curations or create new ones. Once you are happy, submit it as a PR here https://github.com/eshtek/hexos-docs/tree/main/docs/public/install-scripts.
44

5-
**Note**: We're developing a UI for post-install configuration editing. That piece is depenedent on our Local UI still in active development and will be made avialable then.
5+
**Note**: We are developing a UI for post-install configuration editing. That piece is depenedent on our Local UI, still in active development.
66

77
See:
88
- [Quickstart](/install-scripts/quickstart)
99
- [Authoring Guide](/install-scripts/contributing)
1010
- [Reference: Schema](/install-scripts/reference/schema)
11-
- [Reference: Macros](/install-scripts/reference/macros)
1211
- [Reference: Validation Pipeline](/install-scripts/reference/pipeline)
1312
- [Apps (Curated Scripts)](/install-scripts/curated/)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Macros Catalog (canonical)
1+
# Macros
22

3-
coming soon
3+
*needs content explaining all of the possible macros that can be used

0 commit comments

Comments
 (0)