Skip to content

Commit f2f0823

Browse files
rjmunrorjmunro
authored
Merge pull request Sofie-Automation#1650 from Sofie-Automation/rjmunro/update-docs
Update docs for release52 and release53/26.03
2 parents 0312f13 + 4cc230a commit f2f0823

143 files changed

Lines changed: 9273 additions & 24 deletions

File tree

Some content is hidden

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

‎packages/documentation/docs/for-developers/device-integrations/tsr-plugins.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Some useful npm scripts you may wish to copy are:
2727

2828
There are a few key properties that your plugin must conform to, the rest of the structure and how it gets generated is up to you.
2929

30-
1. It must be possible to `require(...)` your plugin folder. The resuling js must contain an export of the format `export const Devices: Record<string, DeviceEntry> = {}`
30+
1. It must be possible to `require(...)` your plugin folder. The resulting js must contain an export of the format `export const Devices: Record<string, DeviceEntry> = {}`
3131
This is how the TSR process finds the entrypoint for your code, and allows you to define multiple device types.
3232

3333
2. There must be a `manifest.json` file at the root of your plugin folder. This should contain json in the form `Record<string, TSRDevicesManifestEntry>`

‎packages/documentation/docs/user-guide/features/prompter.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The prompter can be controlled by different types of controllers. The control mo
4646
| `?mode=shuttlewebhid` | Controlled by a Contour Design ShuttleXpress, using the browser's WebHID API [See configuration details](prompter.md#control-using-contour-shuttlexpress-via-webhid) |
4747
| `?mode=pedal` | Controlled by any MIDI device outputting note values between 0 - 127 of CC notes on channel 8. Analogue Expression pedals work well with TRS-USB midi-converters. [See configuration details](prompter.md#control-using-midi-input-modepedal) |
4848
| `?mode=joycon` | Controlled by Nintendo Switch Joycon, using the HTML5 GamePad API. [See configuration details](prompter.md#control-using-nintendo-joycon-gamepad) |
49-
| `?mode=xbox` | Controlled by Xbox controller, using the HTML5 GamePad API. [See configuration details](prompter.md#control-using-xbox-controller-modexbox) |
49+
| `?mode=xbox` | Controlled by Xbox controller, using the HTML5 GamePad API. [See configuration details](prompter.md#control-using-xbox-controller-modexbox) |
5050

5151
#### Control using mouse \(scroll wheel\)
5252

@@ -175,16 +175,16 @@ This mode uses the browsers Gamapad API and polls connected Joycons for their st
175175

176176
The Joycons can operate in 3 modes, the L-stick, the R-stick or both L+R sticks together. Reconnections and jumping between modes works, with one known limitation: **Transition from L+R to a single stick blocks all input, and requires a reconnect of the sticks you want to use.** This seems to be a bug in either the Joycons themselves or in the Gamepad API in general.
177177

178-
| Query parameter | Type | Description | Default |
179-
| :----------------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------- |
178+
| Query parameter | Type | Description | Default |
179+
| :----------------------- | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------- |
180180
| `joycon_speedMap` | Array of numbers | Speeds to scroll by \(px. pr. frame - approx 60fps\) when scrolling forwards. The beginning of the forwards-range maps to the first number in this array, and the end of the forwards-range map to the end of this array. All values in between are being interpolated in a spline curve. | `[1, 2, 3, 4, 5, 8, 12, 30]` |
181-
| `joycon_reverseSpeedMap` | Array of numbers | Same as `joycon_speedMap` but for the backwards range. | `[1, 2, 3, 4, 5, 8, 12, 30]` |
182-
| `joycon_rangeRevMin` | number | The end of the backwards-range, full speed backwards. | `-1` |
183-
| `joycon_rangeNeutralMin` | number | The beginning of the backwards-range. | `-0.25` |
184-
| `joycon_rangeNeutralMax` | number | The minimum input to run forward, the start of the forward-range \(min speed\). This is also the end of any "deadband" you want filter out before starting moving forwards. | `0.25` |
185-
| `joycon_rangeFwdMax` | number | The maximum input, the end of the forward-range \(max speed\) | `1` |
186-
| `joycon_rightHandOffset` | number | A ratio to increase or decrease the R Joycon joystick sensitivity relative to the L Joycon. | `1.4` |
187-
| `joycon_invertJoystick` | 0 / 1 | Invert the joystick direction. When enabled, pushing the joystick forward scrolls up instead of down. | `1` |
181+
| `joycon_reverseSpeedMap` | Array of numbers | Same as `joycon_speedMap` but for the backwards range. | `[1, 2, 3, 4, 5, 8, 12, 30]` |
182+
| `joycon_rangeRevMin` | number | The end of the backwards-range, full speed backwards. | `-1` |
183+
| `joycon_rangeNeutralMin` | number | The beginning of the backwards-range. | `-0.25` |
184+
| `joycon_rangeNeutralMax` | number | The minimum input to run forward, the start of the forward-range \(min speed\). This is also the end of any "deadband" you want filter out before starting moving forwards. | `0.25` |
185+
| `joycon_rangeFwdMax` | number | The maximum input, the end of the forward-range \(max speed\) | `1` |
186+
| `joycon_rightHandOffset` | number | A ratio to increase or decrease the R Joycon joystick sensitivity relative to the L Joycon. | `1.4` |
187+
| `joycon_invertJoystick` | 0 / 1 | Invert the joystick direction. When enabled, pushing the joystick forward scrolls up instead of down. | `1` |
188188

189189
- `joycon_rangeNeutralMin` has to be greater than `joycon_rangeRevMin`
190190
- `joycon_rangeNeutralMax` has to be greater than `joycon_rangeNeutralMin`
@@ -241,11 +241,11 @@ The controller can be connected via Bluetooth or USB. **Note:** On macOS, Xbox c
241241

242242
**Configuration parameters:**
243243

244-
| Query parameter | Type | Description | Default |
245-
| :--------------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------- |
244+
| Query parameter | Type | Description | Default |
245+
| :--------------------- | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------- |
246246
| `xbox_speedMap` | Array of numbers | Speeds to scroll by (px per frame, ~60fps) when scrolling forwards. Values are interpolated using a spline curve based on trigger pressure. | `[2, 3, 5, 6, 8, 12, 18, 45]` |
247247
| `xbox_reverseSpeedMap` | Array of numbers | Same as `xbox_speedMap` but for the backwards range (left trigger). | `[2, 3, 5, 6, 8, 12, 18, 45]` |
248-
| `xbox_triggerDeadZone` | number | Dead zone for the triggers, to prevent accidental scrolling. Value between 0 and 1. | `0.1` |
248+
| `xbox_triggerDeadZone` | number | Dead zone for the triggers, to prevent accidental scrolling. Value between 0 and 1. | `0.1` |
249249

250250
You can turn on `?debug=1` to see how your trigger input maps to scroll speed.
251251

‎packages/documentation/docusaurus.config.js‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,6 @@ module.exports = {
125125
docs: {
126126
sidebarPath: require.resolve('./sidebars.js'),
127127
editUrl: 'https://github.com/Sofie-Automation/sofie-core/edit/main/packages/documentation/',
128-
// default to the 'next' docs
129-
lastVersion: 'current',
130-
versions: {
131-
// Override the rendering of the 'next' docs to be 'latest'
132-
current: {
133-
label: 'Latest',
134-
banner: 'none',
135-
},
136-
},
137128
},
138129
// blog: {
139130
// showReadingTime: true,

‎packages/documentation/src/components/GitHubReleases.jsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import IconExternalLink from '@docusaurus/theme-classic/lib/theme/Icon/ExternalL
44
const GITHUB_API_URL = 'https://api.github.com'
55

66
export default function GitHubReleases({ org, repo, releaseLabel, state }) {
7-
const [isReady, setIsReady] = useState(0) // 0 - not ready, 1 - loaded, 2 - failed permamently
7+
const [isReady, setIsReady] = useState(0) // 0 - not ready, 1 - loaded, 2 - failed permanently
88
const [releases, setReleases] = useState([])
99

1010
useEffect(() => {

‎packages/documentation/versioned_docs/version-1.52.0/about-sofie.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: About Sofie
3+
hide_table_of_contents: true
4+
sidebar_label: About Sofie
5+
sidebar_position: 1
6+
---
7+
8+
# NRK Sofie TV Automation System
9+
10+
![The producer's view in Sofie](https://raw.githubusercontent.com/Sofie-Automation/Sofie-TV-automation/main/images/Sofie_GUI_example.jpg)
11+
12+
_**Sofie**_ is a web-based TV automation system for studios and live shows, used in daily live TV news productions by the Norwegian public&nbsp;service broadcaster [**NRK**](https://www.nrk.no/about/) since September 2018.
13+
14+
## Key Features
15+
16+
- User-friendly, modern web-based GUI
17+
- State-based device control and playout of video, audio, and graphics
18+
- Modular device-control architecture with support for several hardware \(and software\) setups
19+
- Modular data-ingest architecture, supports MOS and Google spreadsheets
20+
- Plug-in architecture for programming shows
21+
22+
_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._

‎packages/documentation/versioned_docs/version-1.52.0/for-developers/api-documentation.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# API Documentation
6+
7+
The Sofie Blueprints API and the Sofie Peripherals API documentation is automatically generated and available through
8+
[sofie-automation.github.io/sofie-core/typedoc](https://sofie-automation.github.io/sofie-core/typedoc).

‎packages/documentation/versioned_docs/version-1.52.0/for-developers/api-stability.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: API Stability
3+
sidebar_position: 11
4+
---
5+
6+
Sofie has various APIs for talking between components, and for external systems to interact with.
7+
8+
We classify each api into one of two categories:
9+
10+
## Stable
11+
12+
This is a collection of APIs which we intend to avoid introducing any breaking change to unless necessary. This is so external systems can rely on this API without needing to be updated in lockstep with Sofie, and hopefully will make sense to developers who are not familiar with Sofie's inner workings.
13+
14+
In version 1.50, a new REST API was introduced. This can be found at `/api/v1.0`, and is designed to allow an external system to interact with Sofie using simplified abstractions of Sofie internals.
15+
16+
The _Live Status Gateway_ is also part of this stable API, intended to allow for reactively retrieving data from Sofie. Internally it is translating the internal APIs into a stable version.
17+
18+
:::note
19+
You can find the _Live Status Gateway_ in the `packages` folder of the [Sofie Core](https://github.com/Sofie-Automation/sofie-core) repository.
20+
:::
21+
22+
## Internal
23+
24+
This covers everything we expose over DDP, the `/api/0` endpoint and any other http endpoints.
25+
26+
These are intended for use between components of Sofie, which should be updated together. The DDP api does have breaking changes in most releases. We use the `server-core-integration` library to manage these typings, and to ensure that compatible versions are used together.

0 commit comments

Comments
 (0)