Skip to content

Commit db26106

Browse files
committed
documentation update
1 parent 4317691 commit db26106

File tree

137 files changed

+20744
-381
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+20744
-381
lines changed

docs/docs/css/custom.css

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/* Only hide the table of contents (right sidebar) without affecting other spacing */
2+
.md-sidebar--secondary {
3+
display: none !important;
4+
}
5+
6+
/* Style admonitions to match the original "message" class */
7+
.md-typeset .admonition,
8+
.md-typeset details {
9+
border-left: 0.2rem solid #ccc;
10+
background-color: #f9f9f9;
11+
font-size: 0.9em;
12+
margin: 1.5em 0;
13+
padding: 0.8em 1em;
14+
border-radius: 0.1rem;
15+
box-shadow: none;
16+
}
17+
18+
.md-typeset .admonition-title,
19+
.md-typeset summary {
20+
background-color: transparent;
21+
border: none;
22+
font-weight: bold;
23+
margin-bottom: 0.5em;
24+
padding: 0;
25+
margin-top: 0;
26+
}
27+
28+
/* Remove the admonition icon */
29+
.md-typeset .admonition-title::before,
30+
.md-typeset summary::before {
31+
display: none;
32+
}

docs/docs/faq.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# FAQ
2+
3+
## Which OCT raw data format is supported by the Virtual OCT System?
4+
5+
Raw data files that only contain the raw data are supported. The samples in the raw file must have a bit depth between 8 bits and 32 bits, the byte order must be little-endian and the raw data must be unpacked. For example, raw data with packed 12-bit samples (data for two samples is spread over 3 bytes) is currently not supported.
6+
7+
If you have any questions, feel free to contact me: [email protected]

docs/docs/functionality.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Core Functionality
2+
3+
!!! failure
4+
5+
This part of the documentation is still work in progress.
6+
7+
## Overview of the graphical user interface
8+
9+
10+
## Processing tab
11+
12+
## Recording tab
13+
14+
## Scheduled recording
15+
16+
## Saving and loading settings
17+
18+
## Saving and loading view
19+

0 commit comments

Comments
 (0)