Skip to content

Commit

Permalink
Update config and main docs page
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
jeffu231 committed Feb 2, 2023
1 parent a2a4c1f commit 6662728
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 9 deletions.
6 changes: 3 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ url_latest_version = "https://webtest.vixenlights.com"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/VixenLights/webtest.vixenlights.com"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/VixenLights/vixen"
#github_project_repo = "https://github.com/VixenLights/vixen"

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

# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id = "d72aa9b2712488cc3"
# gcs_engine_id = "d72aa9b2712488cc3"

# Enable Algolia DocSearch
#algolia_docsearch = false

# Enable Lunr.js offline search
#offlineSearch = false
offlineSearch = true

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Documentation"
linkTitle: "Documentation"
description: All of the Vixen documentation lives here
description: The Vixen documentation lives here.
weight: 20
menu:
main:
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: "Concepts"
linkTitle: "Concepts"
weight: 4
description: >
Basic concepts of Vixen?
description: This section covers the basic concepts of using Vixen.
---

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).
2 changes: 1 addition & 1 deletion content/en/docs/started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
title: "Getting Started"
weight: 2
description: >
How to get started with Vixen
This section covers topics on getting started with Vixen.
---
2 changes: 1 addition & 1 deletion content/en/docs/tutorials/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Tutorials
weight: 50
description: Tutorials describing how to accomplish things in Vixen
description: This section has various written and video tutorials for using Vixen.
---
2 changes: 1 addition & 1 deletion content/en/docs/usage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Usage"
date: 2017-01-05
weight: 20
description: >
This section will describe all the core features of Vixen.
This section is the main documentation for how to use the features of Vixen.
---


0 comments on commit 6662728

Please sign in to comment.