Skip to content

Commit 0588b5c

Browse files
cuter manual structure
1 parent b5267a8 commit 0588b5c

5 files changed

Lines changed: 13 additions & 14 deletions

File tree

src/api_docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@ Welcome to the OllieOS Program API documentation.
66

77
This document provides an overview of the APIs available to your program and their usage.
88

9-
The APIs and context are exposed to the program by passing a [data object](./interfaces/ProgramMainData.html) to the program's `main` function.
9+
The APIs and context are exposed to the program by passing a [data object](./Program_Types/ProgramMainData.html) to the program's `main` function.
1010

1111
## Categories
1212

13-
### [Userspace API](./documents/Userspace_API.html)
13+
### [Userspace API](./Userspace/Introduction.html)
1414

1515
All programs have access to the Userspace API, providing limited access to the kernel but allowing interaction with the system.
1616

17-
### [Kernel (Privileged) API](./documents/Kernel_(Privileged)_API.html)
17+
### [Kernel (Privileged) API](./Kernel_(Privileged)/Introduction.html)
1818

19-
Programs that start privileged, or successfully [request elevation](./interfaces/UserspaceKernel.html#request_privilege), have access to the Kernel API, which provides full access to the system.
19+
Programs that start privileged, or successfully [request elevation](./Userspace/UserspaceKernel.html#request_privilege), have access to the Kernel API, which provides full access to the system.
2020

2121
This is a responsibility, and programs should only request elevation when absolutely necessary.
2222

23-
### [Program Types](./documents/Program_Types.html)
23+
### [Program Types](./Program_Types/Introduction.html)
2424

2525
Additional information on the type assertions applied to define a program in OllieOS.
2626

2727
## Example Program
2828

29-
Here is a minimal example of how programs are structured in OllieOS, according to the [Program interface](./interfaces/Program_Types.Program.html):
29+
Here is a minimal example of how programs are structured in OllieOS, according to the [Program interface](./Program_Types/Program.html):
3030

3131
```ts
3232
import type { Program } from "ollieos/types";

src/api_docs/privileged_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Kernel (Privileged) API
2+
title: Introduction
33
group: Kernel (Privileged)
4-
category: Introduction
4+
category: 📖 Manual
55
---
66

77
# Kernel (Privileged) API

src/api_docs/types_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Program Types
2+
title: Introduction
33
group: Program Types
4-
category: Introduction
4+
category: 📖 Manual
55
---
66

77
# Program Types

src/api_docs/userspace_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Userspace API
2+
title: Introduction
33
group: Userspace
4-
category: Introduction
4+
category: 📖 Manual
55
---
66

77
# Userspace API

typedoc.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"*"
1515
],
1616
"categoryOrder": [
17-
"Introduction",
17+
"📖 Manual",
1818

1919
"Kernel",
2020
"Terminal",
@@ -28,7 +28,6 @@
2828
"Completions",
2929
"Privileged-by-default Programs"
3030
],
31-
"defaultCategory": "Other",
3231
"readme": "src/api_docs/README.md",
3332
"headings": {
3433
"readme": false

0 commit comments

Comments
 (0)