Skip to content

Commit 6662728

Browse files
committed
Update config and main docs page
* Turn off the project url since we don't use github issues for bug reporting. * Edit the main section descriptions to read better. * Turn on local search indexing.
1 parent a2a4c1f commit 6662728

6 files changed

Lines changed: 8 additions & 9 deletions

File tree

config.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ url_latest_version = "https://webtest.vixenlights.com"
111111
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
112112
github_repo = "https://github.com/VixenLights/webtest.vixenlights.com"
113113
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
114-
github_project_repo = "https://github.com/VixenLights/vixen"
114+
#github_project_repo = "https://github.com/VixenLights/vixen"
115115

116116
# Specify a value here if your content directory is not in your repo's root directory
117117
# github_subdir = ""
@@ -121,13 +121,13 @@ github_project_repo = "https://github.com/VixenLights/vixen"
121121
github_branch= "master"
122122

123123
# Google Custom Search Engine ID. Remove or comment out to disable search.
124-
gcs_engine_id = "d72aa9b2712488cc3"
124+
# gcs_engine_id = "d72aa9b2712488cc3"
125125

126126
# Enable Algolia DocSearch
127127
#algolia_docsearch = false
128128

129129
# Enable Lunr.js offline search
130-
#offlineSearch = false
130+
offlineSearch = true
131131

132132
# Enable syntax highlighting and copy buttons on code blocks with Prism
133133
prism_syntax_highlighting = false

content/en/docs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Documentation"
33
linkTitle: "Documentation"
4-
description: All of the Vixen documentation lives here
4+
description: The Vixen documentation lives here.
55
weight: 20
66
menu:
77
main:

content/en/docs/concepts/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
title: "Concepts"
33
linkTitle: "Concepts"
44
weight: 4
5-
description: >
6-
Basic concepts of Vixen?
5+
description: This section covers the basic concepts of using Vixen.
76
---
87

98
Vixen is quite a paradigm shift from the legacy sequencers in the way the lighting concepts come together. In other software (including Vixen 2.x), it's normally a case of setting up your controllers, and then you have a list of numbered outputs that you can use to sequence on; that is, you're sequencing directly against the outputs/channels for the controller. However, in Vixen, these ideas have been broken down into two distinct areas: the *physical* components of your display (ie. the controllers and their outputs), and the *logical* or *abstract* components of your display (eg. the items or props or fixtures that you have). Additionally, because the design has been broken into these two parts, there's another important component to it: how they actually connect up (eg. how the items/fixtures relate to the controllers and outputs). These three components are called Controllers and Outputs (for the physical components); Elements and Groups (for the logical or abstract components); and Patching (to define how elements are connected to Controllers/Outputs).

content/en/docs/started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: "Getting Started"
33
weight: 2
44
description: >
5-
How to get started with Vixen
5+
This section covers topics on getting started with Vixen.
66
---
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: Tutorials
33
weight: 50
4-
description: Tutorials describing how to accomplish things in Vixen
4+
description: This section has various written and video tutorials for using Vixen.
55
---

content/en/docs/usage/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Usage"
33
date: 2017-01-05
44
weight: 20
55
description: >
6-
This section will describe all the core features of Vixen.
6+
This section is the main documentation for how to use the features of Vixen.
77
---
88

99

0 commit comments

Comments
 (0)