Restructuring of Guide Content

[Whipstickgostop]

Note

This issue is open to discussion and I will be updating it with my own ideas as I have time.

Introduction

Historically much of the content under /guide has been simply "configuration guide" info or more direct param-to-documentation info on each configuration setting.

While this has been simpler to maintain, it is not as useful for truly teaching users how to utilize certain features, understanding basic concepts and patterns, or even achieve common use cases with Streamer.bot.

I would like to propose a shift towards concepts-based guide documentation instead.

Tip

A good example of this is the recent restructuring of the C# Code documentation.

Configuration docs still have their place, but could be moved to a new designated area or integrated as sections within new pages accordingly.

Proposed Restructurings

Warning

WIP various ideas listed below, along with potential new pages that could be added.

Core Concepts

Actions, sub-actions, triggers, and variables are the core building blocks of Streamer.bot and should be emphasized with their own category.

• A dedicated guide to debugging actions and inspecting variables
• A dedicated guide on queues and how to utilize them for common use cases (alerts, etc)

Inputs

These could be things like Commands, Voice Control, MIDI, or other common inputs from triggers (such as Hot Keys)

The main idea here would be "How to I get X data into Streamer.bot, and what do I do with it?"

Platforms

Add general platform docs for common features & use cases shared across platforms:

• First Words
• Present Viewers
• Chat Messages

Give each platform a new landing area with navigation to various docs:

• Twitch
  • Configuration
  • Channel Point Rewards
  • Split any other Twitch docs as needed
• YouTube
  • Configuration
• Kick
  • Configuration

Additional Recipes or Advanced Concepts

• Multi PC Usage
  • How to utilize Remote Signals?